1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Dpdk Utilities Library."""
16 from resources.libraries.python.ssh import SSH, exec_cmd_no_error
19 class DpdkUtil(object):
20 """Utilities for DPDK."""
23 def dpdk_testpmd_start(node, **args):
24 """Start DPDK testpmd app on VM node.
26 :param node: VM Node to start testpmd on.
27 :param args: List of testpmd parameters.
32 # Set the hexadecimal bitmask of the cores to run on.
33 eal_coremask = '-c {} '.format(args['eal_coremask'])\
34 if args.get('eal_coremask', '') else ''
36 eal_master_core = '--master-lcore 0 '
37 # Set the number of memory channels to use.
38 eal_mem_channels = '-n {} '.format(args['eal_mem_channels'])\
39 if args.get('eal_mem_channels', '') else ''
40 # Set the memory to allocate on specific sockets (comma separated).
41 eal_socket_mem = '--socket-mem {} '.format(args['eal_socket_mem'])\
42 if args.get('eal_socket_mem', '') else ''
43 # Load an external driver. Multiple -d options are allowed.
44 eal_driver = '-d /usr/lib/librte_pmd_virtio.so '
45 # Set the forwarding mode: io, mac, mac_retry, mac_swap, flowgen,
46 # rxonly, txonly, csum, icmpecho, ieee1588
47 pmd_fwd_mode = '--forward-mode={} '.format(args['pmd_fwd_mode'])\
48 if args.get('pmd_fwd_mode', '') else ''
49 # Set the number of packets per burst to N.
50 pmd_burst = '--burst=64 '
51 # Set the number of descriptors in the TX rings to N.
52 pmd_txd = '--txd={} '.format(args.get('pmd_txd', '256')) \
53 if args.get('pmd_txd', '256') else ''
54 # Set the number of descriptors in the RX rings to N.
55 pmd_rxd = '--rxd={} '.format(args.get('pmd_rxd', '256')) \
56 if args.get('pmd_rxd', '256') else ''
57 # Set the number of queues in the TX to N.
58 pmd_txq = '--txq={} '.format(args.get('pmd_txq', '1')) \
59 if args.get('pmd_txq', '1') else ''
60 # Set the number of queues in the RX to N.
61 pmd_rxq = '--rxq={} '.format(args.get('pmd_rxq', '1')) \
62 if args.get('pmd_rxq', '1') else ''
63 # Set the hexadecimal bitmask of TX queue flags.
64 pmd_txqflags = '--txqflags=0xf00 '
65 # Set the number of mbufs to be allocated in the mbuf pools.
66 pmd_total_num_mbufs = '--total-num-mbufs={} '.format(\
67 args['pmd_num_mbufs']) if args.get('pmd_num_mbufs', '') else ''
68 # Set the hexadecimal bitmask of the ports for forwarding.
69 pmd_portmask = '--portmask={} '.format(args['pmd_portmask'])\
70 if args.get('pmd_portmask', '') else ''
71 # Disable hardware VLAN.
72 pmd_disable_hw_vlan = '--disable-hw-vlan '\
73 if args.get('pmd_disable_hw_vlan', '') else ''
74 # Disable RSS (Receive Side Scaling).
75 pmd_disable_rss = '--disable-rss '\
76 if args.get('pmd_disable_rss', '') else ''
77 # Set the MAC address XX:XX:XX:XX:XX:XX of the peer port N
78 pmd_eth_peer_0 = '--eth-peer={} '.format(args['pmd_eth_peer_0'])\
79 if args.get('pmd_eth_peer_0', '') else ''
80 pmd_eth_peer_1 = '--eth-peer={} '.format(args['pmd_eth_peer_1'])\
81 if args.get('pmd_eth_peer_1', '') else ''
82 # Set the number of forwarding cores based on coremask.
83 pmd_nb_cores = '--nb-cores={} '.format(\
84 bin(int(args['eal_coremask'], 0)).count('1')-1)\
85 if args.get('eal_coremask', '') else ''
100 + pmd_total_num_mbufs\
102 + pmd_disable_hw_vlan\
109 cmd = "/start-testpmd.sh {0} {1}".format(eal_options, pmd_options)
110 exec_cmd_no_error(node, cmd, sudo=True)
114 def dpdk_testpmd_stop(node):
115 """Stop DPDK testpmd app on node.
117 :param node: Node to stop testpmd on.
123 cmd = "/stop-testpmd.sh"
124 exec_cmd_no_error(node, cmd, sudo=True)