doc/guides/tools/flow-perf.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 Mellanox Technologies, Ltd
   3
   4 Flow Performance Tool
   5 =====================
   6
   7 Application for rte_flow performance testing.
   8 The application provides the ability to test insertion rate of specific
   9 rte_flow rule, by stressing it to the NIC, and calculates the insertion
  10 and deletion rates.
  11
  12 The application allows to configure which rule to apply through several
  13 options of the command line.
  14
  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.
  18
  19 To assess the rule insertion rate, the flow performance tool breaks
  20 down the entire number of flow rule operations into windows of fixed size
  21 (defaults to 100000 flow rule operations per window, but can be configured).
  22 Then, the flow performance tool measures the total time per window and
  23 computes an average time across all windows.
  24
  25 The application also provides the ability to measure rte flow deletion rate,
  26 in addition to memory consumption before and after the flow rules' creation.
  27
  28 The app supports single and multiple core performance measurements, and
  29 support multiple cores insertion/deletion as well.
  30
  31
  32 Compiling the Application
  33 -------------------------
  34
  35 The ``test-flow-perf`` application is compiled as part of the main compilation
  36 of the DPDK libraries and tools.
  37
  38 Refer to the DPDK Getting Started Guides for details.
  39
  40
  41 Running the Application
  42 -----------------------
  43
  44 EAL Command-line Options
  45 ~~~~~~~~~~~~~~~~~~~~~~~~
  46
  47 Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
  48 or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for
  49 a list of available EAL command-line options.
  50
  51
  52 Flow Performance Options
  53 ~~~~~~~~~~~~~~~~~~~~~~~~
  54
  55 The following are the command-line options for the flow performance application.
  56 They must be separated from the EAL options, shown in the previous section,
  57 with a ``--`` separator:
  58
  59 .. code-block:: console
  60
  61         sudo ./dpdk-test-flow_perf -n 4 -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000
  62
  63 The command line options are:
  64
  65 *       ``--help``
  66         Display a help message and quit.
  67
  68 *       ``--rules-count=N``
  69         Set the total number of flow rules to insert,
  70         where 1 <= N <= "number of flow rules".
  71         The default value is 4,000,000.
  72
  73 *       ``--rules-batch=N``
  74         Set the number of flow rules to insert per iteration window,
  75         where 1 <= N <= "number of flow rules per iteration window".
  76         The default value is 100,000 flow rules per iteration window.
  77         For a total of --rules-count=1000000 flow rules to be inserted
  78         and an iteration window size of --rules-batch=100000 flow rules,
  79         the application will measure the insertion rate 10 times
  80         (i.e., once every 100000 flow rules) and then report an average
  81         insertion rate across the 10 measurements.
  82
  83 *       ``--dump-iterations``
  84         Print rates for each iteration window.
  85         Default iteration window equals to the rules-batch size (i.e., 100,000).
  86
  87 *       ``--deletion-rate``
  88         Enable deletion rate calculations.
  89
  90 *       ``--dump-socket-mem``
  91         Dump the memory stats for each socket before the insertion and after.
  92
  93 *       ``--enable-fwd``
  94         Enable packets forwarding after insertion/deletion operations.
  95
  96 *       ``--portmask=N``
  97         hexadecimal bitmask of ports to be used.
  98
  99 *       ``--cores=N``
 100         Set the number of needed cores to insert/delete rte_flow rules.
 101         Default cores count is 1.
 102
 103 *       ``--unique-data``
 104         Flag to set using unique data for all actions that support data,
 105         Such as header modify and encap actions. Default is using fixed
 106         data for any action that support data for all flows.
 107
 108 Attributes:
 109
 110 *       ``--ingress``
 111         Set Ingress attribute to all flows attributes.
 112
 113 *       ``--egress``
 114         Set Egress attribute to all flows attributes.
 115
 116 *       ``--transfer``
 117         Set Transfer attribute to all flows attributes.
 118
 119 *       ``--group=N``
 120         Set group for all flows, where N >= 0.
 121         Default group is 0.
 122
 123 Items:
 124
 125 *       ``--ether``
 126         Add Ether item to all flows items, This item have open mask.
 127
 128 *       ``--vlan``
 129         Add VLAN item to all flows items,
 130         This item have VLAN value defined in user_parameters.h
 131         under ``VNI_VALUE`` with full mask, default value = 1.
 132         Other fields are open mask.
 133
 134 *       ``--ipv4``
 135         Add IPv4 item to all flows items,
 136         This item have incremental source IP, with full mask.
 137         Other fields are open mask.
 138
 139 *       ``--ipv6``
 140         Add IPv6 item to all flows item,
 141         This item have incremental source IP, with full mask.
 142         Other fields are open mask.
 143
 144 *       ``--tcp``
 145         Add TCP item to all flows items, This item have open mask.
 146
 147 *       ``--udp``
 148         Add UDP item to all flows items, This item have open mask.
 149
 150 *       ``--vxlan``
 151         Add VXLAN item to all flows items,
 152         This item have VNI value defined in user_parameters.h
 153         under ``VNI_VALUE`` with full mask, default value = 1.
 154         Other fields are open mask.
 155
 156 *       ``--vxlan-gpe``
 157         Add VXLAN-GPE item to all flows items,
 158         This item have VNI value defined in user_parameters.h
 159         under ``VNI_VALUE`` with full mask, default value = 1.
 160         Other fields are open mask.
 161
 162 *       ``--gre``
 163         Add GRE item to all flows items,
 164         This item have protocol value defined in user_parameters.h
 165         under ``GRE_PROTO`` with full mask, default protocol = 0x6558 "Ether"
 166         Other fields are open mask.
 167
 168 *       ``--geneve``
 169         Add GENEVE item to all flows items,
 170         This item have VNI value defined in user_parameters.h
 171         under ``VNI_VALUE`` with full mask, default value = 1.
 172         Other fields are open mask.
 173
 174 *       ``--gtp``
 175         Add GTP item to all flows items,
 176         This item have TEID value defined in user_parameters.h
 177         under ``TEID_VALUE`` with full mask, default value = 1.
 178         Other fields are open mask.
 179
 180 *       ``--meta``
 181         Add Meta item to all flows items,
 182         This item have data value defined in user_parameters.h
 183         under ``META_DATA`` with full mask, default value = 1.
 184         Other fields are open mask.
 185
 186 *       ``--tag``
 187         Add Tag item to all flows items,
 188         This item have data value defined in user_parameters.h
 189         under ``META_DATA`` with full mask, default value = 1.
 190
 191         Also it have tag value defined in user_parameters.h
 192         under ``TAG_INDEX`` with full mask, default value = 0.
 193         Other fields are open mask.
 194
 195 *       ``--icmpv4``
 196         Add icmpv4 item to all flows items, This item have open mask.
 197
 198 *       ``--icmpv6``
 199         Add icmpv6 item to all flows items, This item have open mask.
 200
 201
 202 Actions:
 203
 204 *       ``--port-id``
 205         Add port redirection action to all flows actions.
 206         Port redirection destination is defined in user_parameters.h
 207         under PORT_ID_DST, default value = 1.
 208
 209 *       ``--rss``
 210         Add RSS action to all flows actions,
 211         The queues in RSS action will be all queues configured
 212         in the app.
 213
 214 *       ``--queue``
 215         Add queue action to all flows items,
 216         The queue will change in round robin state for each flow.
 217
 218         For example:
 219                 The app running with 4 RX queues
 220                 Flow #0: queue index 0
 221                 Flow #1: queue index 1
 222                 Flow #2: queue index 2
 223                 Flow #3: queue index 3
 224                 Flow #4: queue index 0
 225                 ...
 226
 227 *       ``--jump``
 228         Add jump action to all flows actions.
 229         Jump action destination is defined in user_parameters.h
 230         under ``JUMP_ACTION_TABLE``, default value = 2.
 231
 232 *       ``--mark``
 233         Add mark action to all flows actions.
 234         Mark action id is defined in user_parameters.h
 235         under ``MARK_ID``, default value = 1.
 236
 237 *       ``--count``
 238         Add count action to all flows actions.
 239
 240 *       ``--set-meta``
 241         Add set-meta action to all flows actions.
 242         Meta data is defined in user_parameters.h under ``META_DATA``
 243         with full mask, default value = 1.
 244
 245 *       ``--set-tag``
 246         Add set-tag action to all flows actions.
 247         Meta data is defined in user_parameters.h under ``META_DATA``
 248         with full mask, default value = 1.
 249
 250         Tag index is defined in user_parameters.h under ``TAG_INDEX``
 251         with full mask, default value = 0.
 252
 253 *       ``--drop``
 254         Add drop action to all flows actions.
 255
 256 *       ``--hairpin-queue=N``
 257         Add hairpin queue action to all flows actions.
 258         The queue will change in round robin state for each flow.
 259
 260         For example:
 261                 The app running with 4 RX hairpin queues and 4 normal RX queues
 262                 Flow #0: queue index 4
 263                 Flow #1: queue index 5
 264                 Flow #2: queue index 6
 265                 Flow #3: queue index 7
 266                 Flow #4: queue index 4
 267                 ...
 268
 269 *       ``--hairpin-rss=N``
 270         Add hairpin RSS action to all flows actions.
 271         The queues in RSS action will be all hairpin queues configured
 272         in the app.
 273
 274 *       ``--set-src-mac``
 275         Add set source mac action to all flows actions.
 276         The mac to be set is random each flow.
 277
 278 *       ``--set-dst-mac``
 279         Add set destination mac action to all flows actions.
 280         The mac to be set is random each flow.
 281
 282 *       ``-set-src-ipv4``
 283         Add set source ipv4 action to all flows actions.
 284         The ipv4 header to be set is random each flow.
 285
 286 *       ``--set-dst-ipv4``
 287         Add set destination ipv4 action to all flows actions.
 288         The ipv4 header to be set is random each flow.
 289
 290 *       ``--set-src-ipv6``
 291         Add set source ipv6 action to all flows actions.
 292         The ipv6 header to be set is random each flow.
 293
 294 *       ``--set-dst-ipv6``
 295         Add set destination ipv6 action to all flows actions.
 296         The ipv6 header to be set is random each flow.
 297
 298 *       ``--set-src-tp``
 299         Add set source tp action to all flows actions.
 300         The tp sport header to be set is random each flow.
 301
 302 *       ``--set-dst-tp``
 303         Add set destination tp action to all flows actions.
 304         The tp dport header to be set is random each flow.
 305
 306 *       ``--inc-tcp-ack``
 307         Add increment TCP acknowledgment by one to all flows actions.
 308
 309 *       ``--dec-tcp-ack``
 310         Add decrement TCP acknowledgment by one to all flows actions.
 311
 312 *       ``--inc-tcp-seq``
 313         Add increment TCP sequence by one to all flows actions.
 314
 315 *       ``--dec-tcp-seq``
 316         Add decrement TCP sequence by one to all flows actions.
 317
 318 *       ``--set-ttl``
 319         Add set IP ttl action to all flows actions.
 320         The ttl value to be set is random each flow.
 321
 322 *       ``--dec-ttl``
 323         Add decrement IP ttl by one to all flows actions.
 324
 325 *       ``--set-ipv4-dscp``
 326         Add set IPv4 dscp action to all flows actions.
 327         The dscp value to be is random each flow.
 328
 329 *       ``--set-ipv6-dscp``
 330         Add set IPv6 dscp action to all flows actions.
 331         The dscp value to be is random each flow.
 332
 333 *       ``--flag``
 334         Add flag action to all flows actions.
 335
 336 *       ``--raw-encap=<DATA>``
 337         Add raw encap action to all flows actions.
 338         Data is the data needed to be encaped, with fixed values.
 339         Example: raw-encap=ether,ipv4,udp,vxlan
 340
 341 *       ``--raw-decap=<DATA>``
 342         Add raw decap action to all flows actions.
 343         Data is the data needed to be decaped, with fixed values.
 344         Example: raw-decap=ether,ipv4,gre
 345
 346 *       ``--vxlan-encap``
 347         Add vxlan encap action to all flows actions.
 348         Data to encap is fixed with pattern: ether,ipv4,udp,vxlan,
 349         all encapped items have fixed values.
 350
 351 *       ``--vxlan-decap``
 352         Add vxlan decap action to all flows actions.
 353
 354 *       ``--meter``
 355         Add meter action to all flows actions.
 356         Currently, 1 meter profile -> N meter rules -> N rte flows.