1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
# Copyright (c) 2021 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.OptionString import OptionString
from resources.libraries.python.ssh import exec_cmd_no_error
class DpdkUtil:
"""Utilities for DPDK."""
@staticmethod
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
@staticmethod
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 mbuf size.
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
@staticmethod
def get_testpmd_args(**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.extend(DpdkUtil.get_eal_options(**kwargs))
options.add(u"--")
options.extend(DpdkUtil.get_testpmd_pmd_options(**kwargs))
return options
@staticmethod
def get_testpmd_cmdline(**kwargs):
"""Get DPDK testpmd command line arguments with testpmd command.
:param kwargs: Key-value testpmd parameters.
:type kwargs: dict
:returns: Command line string.
:rtype: OptionString
"""
options = OptionString()
options.add(u"dpdk-testpmd")
options.extend(DpdkUtil.get_eal_options(**kwargs))
options.add(u"--")
options.extend(DpdkUtil.get_testpmd_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_testpmd_pmd_options(**kwargs))
exec_cmd_no_error(node, cmd_options, sudo=True, disconnect=True)
@staticmethod
def dpdk_testpmd_stop(node):
"""Stop DPDK testpmd app on node.
:param node: Node to stop testpmd on.
:type node: dict
:returns: nothing
"""
cmd = u"/stop-testpmd.sh" # Completed string, simple one.
exec_cmd_no_error(node, cmd, sudo=True, disconnect=True)
@staticmethod
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
@staticmethod
def get_l3fwd_args(**kwargs):
"""Get DPDK l3fwd command line arguments.
:param kwargs: Key-value l3fwd parameters.
:type kwargs: dict
:returns: Command line string.
:rtype: OptionString
"""
options = OptionString()
options.extend(DpdkUtil.get_eal_options(**kwargs))
options.add(u"--")
options.extend(DpdkUtil.get_l3fwd_pmd_options(**kwargs))
return options
|
