xref: /dpdk/doc/guides/tools/securityperf.rst (revision 1f5cfe964eefe96b5f8de1fadf9cc8fd1e214240)
1.. SPDX-License-Identifier: BSD-3-Clause
2   Copyright(c) 2022 Marvell.
3
4Security Performance Tool
5=========================
6
7The ``dpdk-test-security-perf`` tool is a Data Plane Development Kit (DPDK)
8utility to test ``rte_security`` session create/destroy rates.
9Test covers supported combinations of cipher and auth algorithms.
10
11Limitations
12-----------
13
14* Test only ESP tunnel mode with IPv4.
15
16Running the Application
17-----------------------
18
19EAL Command-line Options
20~~~~~~~~~~~~~~~~~~~~~~~~
21
22Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
23or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>`
24for a list of available EAL command-line options.
25
26Security Performance Options
27~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28
29The following are the command-line options for the security performance
30application.
31They must be separated from the EAL options, shown in the previous section,
32with a ``--`` separator:
33
34.. code-block:: console
35
36   sudo ./dpdk-test-security-perf -- --nb-sess=163840 --inbound
37
38The command-line options are:
39
40``--help``
41  Display a help message and quit.
42
43``--nb-sess``
44  Set the number of sessions to be created, default value is 163840.
45
46``--inbound``
47  IPsec SA direction to be tested with.
48  By default if this option is not provided, outbound direction will be tested.
49