1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 Mellanox Technologies, Ltd
7 Application for rte_flow performance testing.
8 The application provide the ability to test insertion rate of specific
9 rte_flow rule, by stressing it to the NIC, and calculate the insertion
12 The application offers some options in the command line, to configure
15 After that the application will start producing rules with same pattern
16 but increasing the outer IP source address by 1 each time, thus it will
17 give different flow each time, and all other items will have open masks.
23 The current version has limitations which can be removed in future:
25 * Support outer items up to tunnel layer only.
26 * Single core insertion only.
27 * Only one instance of same action can be added in one rule.
30 Compiling the Application
31 =========================
33 The ``test-flow-perf`` application is compiled as part of the main compilation
34 of the DPDK libraries and tools.
36 Refer to the DPDK Getting Started Guides for details.
39 Running the Application
40 =======================
42 EAL Command-line Options
43 ------------------------
45 Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
46 or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for
47 a list of available EAL command-line options.
50 Flow Performance Options
51 ------------------------
53 The following are the command-line options for the flow performance application.
54 They must be separated from the EAL options, shown in the previous section,
55 with a ``--`` separator:
57 .. code-block:: console
59 sudo ./dpdk-test-flow_perf -n 4 -w 08:00.0 -- --ingress --ether --ipv4 --queue --flows-count=1000000
61 The command line options are:
64 Display a help message and quit.
67 Set the number of needed flows to insert,
68 where 1 <= N <= "number of flows".
69 The default value is 4,000,000.
71 * ``--dump-iterations``
72 Print rates for each iteration of flows.
73 Default iteration is 1,00,000.
79 Set Ingress attribute to all flows attributes.
82 Set Egress attribute to all flows attributes.
85 Set Transfer attribute to all flows attributes.
88 Set group for all flows, where N >= 0.
94 Add Ether item to all flows items, This item have open mask.
97 Add VLAN item to all flows items,
98 This item have VLAN value defined in user_parameters.h
99 under ``VNI_VALUE`` with full mask, default value = 1.
100 Other fields are open mask.
103 Add IPv4 item to all flows items,
104 This item have incremental source IP, with full mask.
105 Other fields are open mask.
108 Add IPv6 item to all flows item,
109 This item have incremental source IP, with full mask.
110 Other fields are open mask.
113 Add TCP item to all flows items, This item have open mask.
116 Add UDP item to all flows items, This item have open mask.
119 Add VXLAN item to all flows items,
120 This item have VNI value defined in user_parameters.h
121 under ``VNI_VALUE`` with full mask, default value = 1.
122 Other fields are open mask.
125 Add VXLAN-GPE item to all flows items,
126 This item have VNI value defined in user_parameters.h
127 under ``VNI_VALUE`` with full mask, default value = 1.
128 Other fields are open mask.
131 Add GRE item to all flows items,
132 This item have protocol value defined in user_parameters.h
133 under ``GRE_PROTO`` with full mask, default protocol = 0x6558 "Ether"
134 Other fields are open mask.
137 Add GENEVE item to all flows items,
138 This item have VNI value defined in user_parameters.h
139 under ``VNI_VALUE`` with full mask, default value = 1.
140 Other fields are open mask.
143 Add GTP item to all flows items,
144 This item have TEID value defined in user_parameters.h
145 under ``TEID_VALUE`` with full mask, default value = 1.
146 Other fields are open mask.
149 Add Meta item to all flows items,
150 This item have data value defined in user_parameters.h
151 under ``META_DATA`` with full mask, default value = 1.
152 Other fields are open mask.
155 Add Tag item to all flows items,
156 This item have data value defined in user_parameters.h
157 under ``META_DATA`` with full mask, default value = 1.
159 Also it have tag value defined in user_parameters.h
160 under ``TAG_INDEX`` with full mask, default value = 0.
161 Other fields are open mask.
167 Add port redirection action to all flows actions.
168 Port redirection destination is defined in user_parameters.h
169 under PORT_ID_DST, default value = 1.
172 Add RSS action to all flows actions,
173 The queues in RSS action will be all queues configured
177 Add queue action to all flows items,
178 The queue will change in round robin state for each flow.
181 The app running with 4 RX queues
182 Flow #0: queue index 0
183 Flow #1: queue index 1
184 Flow #2: queue index 2
185 Flow #3: queue index 3
186 Flow #4: queue index 0
190 Add jump action to all flows actions.
191 Jump action destination is defined in user_parameters.h
192 under ``JUMP_ACTION_TABLE``, default value = 2.
195 Add mark action to all flows actions.
196 Mark action id is defined in user_parameters.h
197 under ``MARK_ID``, default value = 1.
200 Add count action to all flows actions.
203 Add set-meta action to all flows actions.
204 Meta data is defined in user_parameters.h under ``META_DATA``
205 with full mask, default value = 1.
208 Add set-tag action to all flows actions.
209 Meta data is defined in user_parameters.h under ``META_DATA``
210 with full mask, default value = 1.
212 Tag index is defined in user_parameters.h under ``TAG_INDEX``
213 with full mask, default value = 0.
216 Add drop action to all flows actions.
218 * ``--hairpin-queue=N``
219 Add hairpin queue action to all flows actions.
220 The queue will change in round robin state for each flow.
223 The app running with 4 RX hairpin queues and 4 normal RX queues
224 Flow #0: queue index 4
225 Flow #1: queue index 5
226 Flow #2: queue index 6
227 Flow #3: queue index 7
228 Flow #4: queue index 4
231 * ``--hairpin-rss=N``
232 Add hairpin RSS action to all flows actions.
233 The queues in RSS action will be all hairpin queues configured