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