doc: describe new performance test application
Add documentation to describe using the new performance test application. Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com> Signed-off-by: Piotr Azarewicz <piotrx.t.azarewicz@intel.com>
This commit is contained in:
Slawomir Mrozowicz
Pablo de Lara
parent
5f1d85c5a8
commit
c6baca7adc
@ -653,6 +653,7 @@ F: doc/guides/testpmd_app_ug/
|
||||
Crypto performance test application
|
||||
M: Declan Doherty <declan.doherty@intel.com>
|
||||
F: app/test-crypto-perf/
|
||||
F: doc/guides/tools/cryptoperf.rst
|
||||
|
||||
Procinfo tool
|
||||
M: Maryam Tahhan <maryam.tahhan@intel.com>
|
||||
|
||||
@ -192,6 +192,11 @@ New Features
|
||||
* Scatter-gatter support for chained mbufs (only out-of place and destination
|
||||
mbuf must be contiguous)
|
||||
|
||||
* **Added crypto performance test application.**
|
||||
|
||||
A new performance test application allows measuring performance parameters
|
||||
of PMDs available in crypto tree.
|
||||
|
||||
* **Added Elastic Flow Distributor library (rte_efd).**
|
||||
|
||||
This new library uses perfect hashing to determine a target/value for a
|
||||
|
||||
397
doc/guides/tools/cryptoperf.rst
Normal file
397
doc/guides/tools/cryptoperf.rst
Normal file
@ -0,0 +1,397 @@
|
||||
.. BSD LICENSE
|
||||
Copyright(c) 2016 Intel Corporation. All rights reserved.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Intel Corporation nor the names of its
|
||||
contributors may be used to endorse or promote products derived
|
||||
from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
dpdk-test-crypto-perf Application
|
||||
=================================
|
||||
|
||||
The ``dpdk-test-crypto-perf`` tool is a Data Plane Development Kit (DPDK)
|
||||
utility that allows measuring performance parameters of PMDs available in the
|
||||
crypto tree. There are available two measurement types: throughput and latency.
|
||||
User can use multiply cores to run tests on but only
|
||||
one type of crypto PMD can be measured during single application
|
||||
execution. Cipher parameters, type of device, type of operation and
|
||||
chain mode have to be specified in the command line as application
|
||||
parameters. These parameters are checked using device capabilities
|
||||
structure.
|
||||
|
||||
Compiling the Application
|
||||
-------------------------
|
||||
|
||||
**Step 1: PMD setting**
|
||||
|
||||
The ``dpdk-test-crypto-perf`` tool depends on crypto device drivers PMD which
|
||||
are disabled by default in the build configuration file ``common_base``.
|
||||
The crypto device drivers PMD which should be tested can be enabled by setting::
|
||||
|
||||
CONFIG_RTE_LIBRTE_PMD_<name>=y
|
||||
|
||||
Setting example for open ssl PMD::
|
||||
|
||||
CONFIG_RTE_LIBRTE_PMD_OPENSSL=y
|
||||
|
||||
**Step 2: Linearization setting**
|
||||
|
||||
It is possible linearized input segmented packets just before crypto operation
|
||||
for devices which doesn't support scatter-gather, and allows to measure
|
||||
performance also for this use case.
|
||||
|
||||
To set on the linearization options add below definition to the
|
||||
``cperf_ops.h`` file::
|
||||
|
||||
#define CPERF_LINEARIZATION_ENABLE
|
||||
|
||||
**Step 3: Build the application**
|
||||
|
||||
Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
|
||||
``dpdk-test-crypto-perf`` applcation.
|
||||
|
||||
Initially, the user must select a DPDK target to choose the correct target type
|
||||
and compiler options to use when building the libraries.
|
||||
The user must have all libraries, modules, updates and compilers installed
|
||||
in the system prior to this,
|
||||
as described in the earlier chapters in this Getting Started Guide.
|
||||
|
||||
Running the Application
|
||||
-----------------------
|
||||
|
||||
The tool application has a number of command line options:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
dpdk-test-crypto-perf [EAL Options] -- [Application Options]
|
||||
|
||||
EAL Options
|
||||
~~~~~~~~~~~
|
||||
|
||||
The following are the EAL command-line options that can be used in conjunction
|
||||
with the ``dpdk-test-crypto-perf`` applcation.
|
||||
See the DPDK Getting Started Guides for more information on these options.
|
||||
|
||||
* ``-c <COREMASK>``
|
||||
|
||||
Set the hexadecimal bitmask of the cores to run on.
|
||||
|
||||
* ``-w <PCI>``
|
||||
|
||||
Add a PCI device in white list.
|
||||
|
||||
* ``--vdev <driver><id>``
|
||||
|
||||
Add a virtual device.
|
||||
|
||||
Appication Options
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The following are the appication command-line options:
|
||||
|
||||
* ``--ptest type``
|
||||
|
||||
Set test type, where ``type`` is one of the following::
|
||||
|
||||
throughput
|
||||
latency
|
||||
|
||||
* ``--silent``
|
||||
|
||||
Disable options dump.
|
||||
|
||||
* ``--pool-sz <n>``
|
||||
|
||||
Set the number of mbufs to be allocated in the mbuf pool.
|
||||
|
||||
* ``--total-ops <n>``
|
||||
|
||||
Set the number of total operations performed.
|
||||
|
||||
* ``--burst-sz <n>``
|
||||
|
||||
Set the number of packets per burst.
|
||||
|
||||
* ``--buffer-sz <n>``
|
||||
|
||||
Set the size of single packet (plaintext or ciphertext in it).
|
||||
|
||||
* ``--segments-nb <n>``
|
||||
|
||||
Set the number of segments per packet.
|
||||
|
||||
* ``--devtype <name>``
|
||||
|
||||
Set device type, where ``name`` is one of the following::
|
||||
|
||||
crypto_null
|
||||
crypto_aesni_mb
|
||||
crypto_aesni_gcm
|
||||
crypto_openssl
|
||||
crypto_qat
|
||||
crypto_snow3g
|
||||
crypto_kasumi
|
||||
crypto_zuc
|
||||
|
||||
* ``--optype <name>``
|
||||
|
||||
Set operation type, where ``name`` is one of the following::
|
||||
|
||||
cipher-only
|
||||
auth-only
|
||||
cipher-then-auth
|
||||
auth-then-cipher
|
||||
aead
|
||||
|
||||
* ``--sessionless``
|
||||
|
||||
Enable session-less crypto operations mode.
|
||||
|
||||
* ``--out-of-place``
|
||||
|
||||
Enable out-of-place crypto operations mode.
|
||||
|
||||
* ``--verify``
|
||||
|
||||
Enable verify that all crypto operations were successful.
|
||||
The verification is done after the performance test.
|
||||
|
||||
* ``--test-file <name>``
|
||||
|
||||
Set test vector file path. See the Test Vector File chapter.
|
||||
|
||||
* ``--test-name <name>``
|
||||
|
||||
Set specific test name section in the test vector file.
|
||||
|
||||
* ``--cipher-algo <name>``
|
||||
|
||||
Set cipher algorithm name, where ``name`` is one of the following::
|
||||
|
||||
3des-cbc
|
||||
3des-ecb
|
||||
3des-ctr
|
||||
aes-cbc
|
||||
aes-ccm
|
||||
aes-ctr
|
||||
aes-ecb
|
||||
aes-gcm
|
||||
aes-f8
|
||||
aes-xts
|
||||
arc4
|
||||
null
|
||||
kasumi-f8
|
||||
snow3g-uea2
|
||||
zuc-eea3
|
||||
|
||||
* ``--cipher-op <mode>``
|
||||
|
||||
Set cipher operation mode, where ``mode`` is one of the following::
|
||||
|
||||
encrypt
|
||||
decrypt
|
||||
|
||||
* ``--cipher-key-sz <n>``
|
||||
|
||||
Set the size of cipher key.
|
||||
|
||||
* ``--cipher-iv-sz <n>``
|
||||
|
||||
Set the size of cipher iv.
|
||||
|
||||
* ``--auth-algo <name>``
|
||||
|
||||
Set authentication algorithm name, where ``name`` is one
|
||||
of the following::
|
||||
|
||||
3des-cbc
|
||||
aes-cbc-mac
|
||||
aes-ccm
|
||||
aes-cmac
|
||||
aes-gcm
|
||||
aes-gmac
|
||||
aes-xcbc-mac
|
||||
md5
|
||||
md5-hmac
|
||||
sha1
|
||||
sha1-hmac
|
||||
sha2-224
|
||||
sha2-224-hmac
|
||||
sha2-256
|
||||
sha2-256-hmac
|
||||
sha2-384
|
||||
sha2-384-hmac
|
||||
sha2-512
|
||||
sha2-512-hmac
|
||||
kasumi-f9
|
||||
snow3g-uia2
|
||||
zuc-eia3
|
||||
|
||||
* ``--auth-op <mode>``
|
||||
|
||||
Set authentication operation mode, where ``mode`` is one of
|
||||
the following::
|
||||
|
||||
verify
|
||||
generate
|
||||
|
||||
* ``--auth-key-sz <n>``
|
||||
|
||||
Set the size of authentication key.
|
||||
|
||||
* ``--auth-digest-sz <n>``
|
||||
|
||||
Set the size of authentication digest.
|
||||
|
||||
* ``--auth-aad-sz <n>``
|
||||
|
||||
Set the size of authentication aad.
|
||||
|
||||
* ``--csv-friendly``
|
||||
|
||||
Enable test result output CSV friendly rather than human friendly.
|
||||
|
||||
Test Vector File
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
The test vector file is a text file contain information about test vectors.
|
||||
The file is made of the sections. The first section doesn't have header.
|
||||
It contain global information used in each test variant vectors -
|
||||
typicaly information about plaintext, ciphertext, cipher key, aut key,
|
||||
initial vector. All other sections begin header.
|
||||
The sections contain particular information typicaly digest.
|
||||
|
||||
**Format of the file:**
|
||||
|
||||
Each line beginig with sign '#' contain comment and it is ignored by parser::
|
||||
|
||||
# <comment>
|
||||
|
||||
Header line is just name in square bracket::
|
||||
|
||||
[<section name>]
|
||||
|
||||
Data line contain information tocken then sign '=' and
|
||||
a string of bytes in C byte array format::
|
||||
|
||||
<tocken> = <C byte array>
|
||||
|
||||
**Tockens list:**
|
||||
|
||||
* ``plaintext``
|
||||
|
||||
Original plaintext to be crypted.
|
||||
|
||||
* ``ciphertext``
|
||||
|
||||
Encrypted plaintext string.
|
||||
|
||||
* ``cipher_key``
|
||||
|
||||
Key used in cipher operation.
|
||||
|
||||
* ``auth_key``
|
||||
|
||||
Key used in auth operation.
|
||||
|
||||
* ``iv``
|
||||
|
||||
Initial vector.
|
||||
|
||||
* ``aad``
|
||||
|
||||
Additional data.
|
||||
|
||||
* ``digest``
|
||||
|
||||
Digest string.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Call application for performance throughput test of single Aesni MB PMD
|
||||
for cipher encryption aes-cbc and auth generation sha1-hmac,
|
||||
one milion operations, burst size 32, packet size 64::
|
||||
|
||||
dpdk-test-crypto-perf -c 0xc0 --vdev crypto_aesni_mb_pmd -w 0000:00:00.0 --
|
||||
--ptest throughput --devtype crypto_aesni_mb --optype cipher-then-auth
|
||||
--cipher-algo aes-cbc --cipher-op encrypt --cipher-key-sz 16 --auth-algo
|
||||
sha1-hmac --auth-op generate --auth-key-sz 64 --auth-digest-sz 12
|
||||
--total-ops 10000000 --burst-sz 32 --buffer-sz 64
|
||||
|
||||
Call application for performance latency test of two Aesni MB PMD executed
|
||||
on two cores for cipher encryption aes-cbc, ten operations in silent mode::
|
||||
|
||||
dpdk-test-crypto-perf -c 0xf0 --vdev crypto_aesni_mb_pmd1
|
||||
--vdev crypto_aesni_mb_pmd2 -w 0000:00:00.0 -- --devtype crypto_aesni_mb
|
||||
--cipher-algo aes-cbc --cipher-key-sz 16 --cipher-iv-sz 16
|
||||
--cipher-op encrypt --optype cipher-only --silent
|
||||
--ptest latency --total-ops 10
|
||||
|
||||
Call application for performance latency test of single open ssl PMD
|
||||
for cipher encryption aes-gcm and auth generation aes-gcm,ten operations
|
||||
in silent mode, test vector provide in file "test_aes_gcm.data"
|
||||
with packet verification::
|
||||
|
||||
dpdk-test-crypto-perf -c 0xf0 --vdev crypto_openssl -w 0000:00:00.0 --
|
||||
--devtype crypto_openssl --cipher-algo aes-gcm --cipher-key-sz 16
|
||||
--cipher-iv-sz 16 --cipher-op encrypt --auth-algo aes-gcm --auth-key-sz 16
|
||||
--auth-digest-sz 16 --auth-aad-sz 16 --auth-op generate --optype aead
|
||||
--silent --ptest latency --total-ops 10
|
||||
--test-file test_aes_gcm.data --verify
|
||||
|
||||
Test vector file for cipher algorithm aes cbc 256 with authorization sha::
|
||||
|
||||
# Global Section
|
||||
plaintext =
|
||||
0xff, 0xca, 0xfb, 0xf1, 0x38, 0x20, 0x2f, 0x7b, 0x24, 0x98, 0x26, 0x7d, 0x1d, 0x9f, 0xb3, 0x93,
|
||||
0xd9, 0xef, 0xbd, 0xad, 0x4e, 0x40, 0xbd, 0x60, 0xe9, 0x48, 0x59, 0x90, 0x67, 0xd7, 0x2b, 0x7b,
|
||||
0x8a, 0xe0, 0x4d, 0xb0, 0x70, 0x38, 0xcc, 0x48, 0x61, 0x7d, 0xee, 0xd6, 0x35, 0x49, 0xae, 0xb4,
|
||||
0xaf, 0x6b, 0xdd, 0xe6, 0x21, 0xc0, 0x60, 0xce, 0x0a, 0xf4, 0x1c, 0x2e, 0x1c, 0x8d, 0xe8, 0x7b
|
||||
ciphertext =
|
||||
0x77, 0xF9, 0xF7, 0x7A, 0xA3, 0xCB, 0x68, 0x1A, 0x11, 0x70, 0xD8, 0x7A, 0xB6, 0xE2, 0x37, 0x7E,
|
||||
0xD1, 0x57, 0x1C, 0x8E, 0x85, 0xD8, 0x08, 0xBF, 0x57, 0x1F, 0x21, 0x6C, 0xAD, 0xAD, 0x47, 0x1E,
|
||||
0x0D, 0x6B, 0x79, 0x39, 0x15, 0x4E, 0x5B, 0x59, 0x2D, 0x76, 0x87, 0xA6, 0xD6, 0x47, 0x8F, 0x82,
|
||||
0xB8, 0x51, 0x91, 0x32, 0x60, 0xCB, 0x97, 0xDE, 0xBE, 0xF0, 0xAD, 0xFC, 0x23, 0x2E, 0x22, 0x02
|
||||
cipher_key =
|
||||
0xE4, 0x23, 0x33, 0x8A, 0x35, 0x64, 0x61, 0xE2, 0x49, 0x03, 0xDD, 0xC6, 0xB8, 0xCA, 0x55, 0x7A,
|
||||
0xd0, 0xe7, 0x4b, 0xfb, 0x5d, 0xe5, 0x0c, 0xe7, 0x6f, 0x21, 0xb5, 0x52, 0x2a, 0xbb, 0xc7, 0xf7
|
||||
auth_key =
|
||||
0xaf, 0x96, 0x42, 0xf1, 0x8c, 0x50, 0xdc, 0x67, 0x1a, 0x43, 0x47, 0x62, 0xc7, 0x04, 0xab, 0x05,
|
||||
0xf5, 0x0c, 0xe7, 0xa2, 0xa6, 0x23, 0xd5, 0x3d, 0x95, 0xd8, 0xcd, 0x86, 0x79, 0xf5, 0x01, 0x47,
|
||||
0x4f, 0xf9, 0x1d, 0x9d, 0x36, 0xf7, 0x68, 0x1a, 0x64, 0x44, 0x58, 0x5d, 0xe5, 0x81, 0x15, 0x2a,
|
||||
0x41, 0xe4, 0x0e, 0xaa, 0x1f, 0x04, 0x21, 0xff, 0x2c, 0xf3, 0x73, 0x2b, 0x48, 0x1e, 0xd2, 0xf7
|
||||
iv =
|
||||
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F
|
||||
# Section sha 1 hmac buff 32
|
||||
[sha1_hmac_buff_32]
|
||||
digest =
|
||||
0x36, 0xCA, 0x49, 0x6A, 0xE3, 0x54, 0xD8, 0x4F, 0x0B, 0x76, 0xD8, 0xAA, 0x78, 0xEB, 0x9D, 0x65,
|
||||
0x2C, 0xCA, 0x1F, 0x97
|
||||
# Section sha 256 hmac buff 32
|
||||
[sha256_hmac_buff_32]
|
||||
digest =
|
||||
0x1C, 0xB2, 0x3D, 0xD1, 0xF9, 0xC7, 0x6C, 0x49, 0x2E, 0xDA, 0x94, 0x8B, 0xF1, 0xCF, 0x96, 0x43,
|
||||
0x67, 0x50, 0x39, 0x76, 0xB5, 0xA1, 0xCE, 0xA1, 0xD7, 0x77, 0x10, 0x07, 0x43, 0x37, 0x05, 0xB4
|
||||
@ -39,4 +39,5 @@ DPDK Tools User Guides
|
||||
pdump
|
||||
pmdinfo
|
||||
devbind
|
||||
cryptoperf
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user