src/plugins/igmp/igmp_api.c

# Copyright (c) 2016 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:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Dpdk Utilities Library."""

from resources.libraries.python.ssh import SSH, exec_cmd_no_error


class DpdkUtil(object):
    """Utilities for DPDK."""

    @staticmethod
    def get_eal_options(**args):
        """Create EAL parameters string.

        :param args: List of testpmd parameters.
        :type args: dict
        :returns: EAL parameters string.
        :rtype: str
        """
        # Set the hexadecimal bitmask of the cores to run on.
        eal_coremask = '-c {} '.format(args['eal_coremask'])\
            if args.get('eal_coremask', '') else ''
        # Set master core.
        eal_master_core = '--master-lcore 0 '
        # 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 ''
        # Load an external driver. Multiple -d options are allowed.
        eal_driver = '-d /usr/lib/librte_pmd_virtio.so '
        eal_options = '-v '\
            + eal_coremask\
            + eal_master_core\
            + eal_mem_channels\
            + eal_socket_mem\
            + eal_driver
        return eal_options

    @staticmethod
    def get_pmd_options(**args):
        """Create PMD parameters string.

        :param args: List of testpmd parameters.
        :type args: dict
        :returns: PMD parameters string.
        :rtype: str
        """
        # 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 ''
        # Set the number of packets per burst to N.
        pmd_burst = '--burst=64 '
        # Set the number of descriptors in the TX rings to N.
        pmd_txd = '--txd={} '.format(args.get('pmd_txd', '256')) \
            if args.get('pmd_txd', '256') else ''
        # Set the number of descriptors in the RX rings to N.
        pmd_rxd = '--rxd={} '.format(args.get('pmd_rxd', '256')) \
            if args.get('pmd_rxd', '256') else ''
        # 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 ''
        # 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 queue flags.
        pmd_txqflags = '--txqflags=0xf00 '
        # Set the number of mbufs to be allocated in the mbuf pools.
        pmd_total_num_mbufs = '--total-num-mbufs={} '.format(
            args['pmd_num_mbufs']) if args.get('pmd_num_mbufs', '') else ''
        # Set the max packet length.
        pmd_max_pkt_len = "--max-pkt-len={0}".format(args["pmd_max_pkt_len"]) \
            if args.get("pmd_max_pkt_len", "") else ""
        # Set the hexadecimal bitmask of the ports for forwarding.
        pmd_portmask = '--portmask={} '.format(args['pmd_portmask'])\
            if args.get('pmd_portmask', '') else ''
        # 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 MAC address XX:XX:XX:XX:XX:XX of the peer port N
        pmd_eth_peer_0 = '--eth-peer={} '.format(args['pmd_eth_peer_0'])\
            if args.get('pmd_eth_peer_0', '') else ''
        pmd_eth_peer_1 = '--eth-peer={} '.format(args['pmd_eth_peer_1'])\
            if args.get('pmd_eth_peer_1', '') else ''
        # Set the number of forwarding cores based on coremask.
        pmd_nb_cores = '--nb-cores={} '.format(
            bin(int(args['eal_coremask'], 0)).count('1')-1)\
            if args.get('eal_coremask', '') else ''
        pmd_options = '-- '\
            + pmd_fwd_mode\
            + pmd_burst\
            + pmd_txd\
            + pmd_rxd\
            + pmd_txq\
            + pmd_rxq\
            + pmd_txqflags\
            + pmd_total_num_mbufs\
            + pmd_portmask\
            + pmd_disable_hw_vlan\
            + pmd_disable_rss\
            + pmd_eth_peer_0\
            + pmd_eth_peer_1\
            + pmd_nb_cores\
            + pmd_max_pkt_len
        return pmd_options

    @staticmethod
    def dpdk_testpmd_start(node, **args):
        """Start DPDK testpmd app on VM node.

        :param node: VM Node to start testpmd on.
        :param args: List of testpmd parameters.
        :type node: dict
        :type args: dict
        :return: nothing
        """
        eal_options = DpdkUtil.get_eal_options(**args)
        pmd_options = DpdkUtil.get_pmd_options(**args)

        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)

    @staticmethod
    def dpdk_testpmd_stop(node):
        """Stop DPDK testpmd app on node.

        :param node: Node to stop testpmd on.
        :type node: dict
        :return: nothing
        """
        ssh = SSH()
        ssh.connect(node)
        cmd = "/stop-testpmd.sh"
        exec_cmd_no_error(node, cmd, sudo=True)
        ssh.disconnect(node)
Age	Commit message (Expand)	Author	Files	Lines
2019-04-10	API: Fix shared memory only action handlers.	Ole Troan	1	-21/+21
2018-12-13	make build failure.	Paul Vinciguerra	1	-2/+2
2018-12-06	API: Change ip4_address and ip6_address to use type alias.	Ole Troan	1	-2/+2
2018-10-23	c11 safe string handling support	Dave Barach	1	-5/+5
2018-10-16	IGMP: proxy device	Jakub Grajciar	1	-9/+48
2018-07-10	IGMP: coverity found defects	Neale Ranns	1	-1/+1
2018-07-09	IGMP improvements	Neale Ranns	1	-104/+186
2018-06-29	igmp: bugfix and minor improvements	Jakub Grajciar	1	-1/+3
2018-06-10	IGMP: use simple u32 bit hash key	Neale Ranns	1	-9/+8
2018-06-08	Add reaper functions to want events APIs (VPP-1304)	Neale Ranns	1	-4/+41
2018-04-25	igmp: data structure refactoring	Jakub Grajciar	1	-19/+27
2018-03-19	IGMP plugin	Jakub Grajciar	1	-0/+337