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
   9
  10 Compiling the Application
  11 =========================
  12
  13 The ``test-flow-perf`` application is compiled as part of the main compilation
  14 of the DPDK libraries and tools.
  15
  16 Refer to the DPDK Getting Started Guides for details.
  17
  18
  19 Running the Application
  20 =======================
  21
  22 EAL Command-line Options
  23 ------------------------
  24
  25 Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
  26 or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for
  27 a list of available EAL command-line options.
  28
  29
  30 Flow Performance Options
  31 ------------------------
  32
  33 The following are the command-line options for the flow performance application.
  34 They must be separated from the EAL options, shown in the previous section,
  35 with a ``--`` separator:
  36
  37 .. code-block:: console
  38
  39         sudo ./dpdk-test-flow-perf -n 4 -w 08:00.0 --
  40
  41 The command line options are:
  42
  43 *       ``--help``
  44         Display a help message and quit.