X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FDpdkUtil.py;h=3a04cbd021b063c295fc53468944adc997f68957;hp=4b00167cee6d5dc765f223887d365d9ae699e0c0;hb=d68951ac245150eeefa6e0f4156e4c1b5c9e9325;hpb=cf561a6e3d4c4fbd78ab6c9d0a9aa817bb3300fc diff --git a/resources/libraries/python/DpdkUtil.py b/resources/libraries/python/DpdkUtil.py index 4b00167cee..3a04cbd021 100644 --- a/resources/libraries/python/DpdkUtil.py +++ b/resources/libraries/python/DpdkUtil.py @@ -1,4 +1,4 @@ -# 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: @@ -13,98 +13,112 @@ """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 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=u"-") + options.add(u"v") # Set the hexadecimal bitmask of the cores to run on. - eal_coremask = '-c {} '.format(args['eal_coremask'])\ - if args.get('eal_coremask', '') else '' + options.add_with_value_from_dict(u"l", u"eal_corelist", kwargs) # 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 '' + options.add_with_value(u"-master-lcore", u"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( + 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(**kwargs): + """Create PMD parameters options (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 - pmd_fwd_mode = '--forward-mode={} '.format(args['pmd_fwd_mode'])\ - if args.get('pmd_fwd_mode', '') 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=256 ' + 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=256 ' + 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=1 ' + 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=1 ' - # Set the hexadecimal bitmask of TX queue flags. - pmd_txqflags = '--txqflags=0xf00 ' + 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) # 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 hexadecimal bitmask of the ports for forwarding. - pmd_portmask = '--portmask={} '.format(args['pmd_portmask'])\ - if args.get('pmd_portmask', '') else '' + options.add_equals_from_dict( + u"total-num-mbufs", u"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 '' + options.add_if_from_dict( + u"disable-hw-vlan", u"pmd_disable_hw_vlan", 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['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 '' + 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 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 '' - eal_options = '-v '\ - + eal_coremask\ - + eal_master_core\ - + eal_mem_channels\ - + eal_socket_mem\ - + eal_driver - 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 - 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(u"nb-cores", u"pmd_nb_cores", kwargs) + return options + + @staticmethod + def get_testpmd_cmdline(**kwargs): + """Get DPDK testpmd command line arguments. + + :param kwargs: Key-value testpmd parameters. + :type kwargs: dict + :returns: Command line string. + :rtype: OptionString + """ + options = OptionString() + options.add(u"testpmd") + options.extend(DpdkUtil.get_eal_options(**kwargs)) + options.add(u"--") + 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 kwargs: Key-value testpmd parameters. + :type node: dict + :type kwargs: dict + """ + 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_pmd_options(**kwargs)) + exec_cmd_no_error(node, cmd_options, sudo=True, disconnect=True) @staticmethod def dpdk_testpmd_stop(node): @@ -112,10 +126,7 @@ class DpdkUtil(object): :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 = u"/stop-testpmd.sh" # Completed string, simple one. + exec_cmd_no_error(node, cmd, sudo=True, disconnect=True)