2 Copyright(c) 2016 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 dpdk-test-crypto-perf Application
32 =================================
34 The ``dpdk-test-crypto-perf`` tool is a Data Plane Development Kit (DPDK)
35 utility that allows measuring performance parameters of PMDs available in the
36 crypto tree. There are available two measurement types: throughput and latency.
37 User can use multiply cores to run tests on but only
38 one type of crypto PMD can be measured during single application
39 execution. Cipher parameters, type of device, type of operation and
40 chain mode have to be specified in the command line as application
41 parameters. These parameters are checked using device capabilities
46 On hardware devices the cycle-count doesn't always represent the actual offload
47 cost. The cycle-count only represents the offload cost when the hardware
48 accelerator is not fully loaded, when loaded the cpu cycles freed up by the
49 offload are still consumed by the test tool and included in the cycle-count.
50 These cycles are consumed by retries and inefficient API calls enqueuing and
51 dequeuing smaller bursts than specified by the cmdline parameter. This results
52 in a larger cycle-count measurement and should not be interpreted as an offload
55 On hardware devices the throughput measurement is not necessarily the maximum
56 possible for the device, e.g. it may be necessary to use multiple cores to keep
57 the hardware accelerator fully loaded and so measure maximum throughput.
59 Compiling the Application
60 -------------------------
62 **Step 1: PMD setting**
64 The ``dpdk-test-crypto-perf`` tool depends on crypto device drivers PMD which
65 are disabled by default in the build configuration file ``common_base``.
66 The crypto device drivers PMD which should be tested can be enabled by setting::
68 CONFIG_RTE_LIBRTE_PMD_<name>=y
70 Setting example for open ssl PMD::
72 CONFIG_RTE_LIBRTE_PMD_OPENSSL=y
74 **Step 2: Linearization setting**
76 It is possible linearized input segmented packets just before crypto operation
77 for devices which doesn't support scatter-gather, and allows to measure
78 performance also for this use case.
80 To set on the linearization options add below definition to the
81 ``cperf_ops.h`` file::
83 #define CPERF_LINEARIZATION_ENABLE
85 **Step 3: Build the application**
87 Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
88 ``dpdk-test-crypto-perf`` applcation.
90 Initially, the user must select a DPDK target to choose the correct target type
91 and compiler options to use when building the libraries.
92 The user must have all libraries, modules, updates and compilers installed
93 in the system prior to this,
94 as described in the earlier chapters in this Getting Started Guide.
96 Running the Application
97 -----------------------
99 The tool application has a number of command line options:
101 .. code-block:: console
103 dpdk-test-crypto-perf [EAL Options] -- [Application Options]
108 The following are the EAL command-line options that can be used in conjunction
109 with the ``dpdk-test-crypto-perf`` applcation.
110 See the DPDK Getting Started Guides for more information on these options.
112 * ``-c <COREMASK>`` or ``-l <CORELIST>``
114 Set the hexadecimal bitmask of the cores to run on. The corelist is a
119 Add a PCI device in white list.
121 * ``--vdev <driver><id>``
123 Add a virtual device.
128 The following are the appication command-line options:
132 Set test type, where ``type`` is one of the following::
140 Disable options dump.
144 Set the number of mbufs to be allocated in the mbuf pool.
146 * ``--total-ops <n>``
148 Set the number of total operations performed.
152 Set the number of packets per burst.
154 * ``--buffer-sz <n>``
156 Set the size of single packet (plaintext or ciphertext in it).
158 * ``--segments-nb <n>``
160 Set the number of segments per packet.
162 * ``--devtype <name>``
164 Set device type, where ``name`` is one of the following::
175 * ``--optype <name>``
177 Set operation type, where ``name`` is one of the following::
185 For GCM/CCM algorithms you should use aead flag.
189 Enable session-less crypto operations mode.
193 Enable out-of-place crypto operations mode.
195 * ``--test-file <name>``
197 Set test vector file path. See the Test Vector File chapter.
199 * ``--test-name <name>``
201 Set specific test name section in the test vector file.
203 * ``--cipher-algo <name>``
205 Set cipher algorithm name, where ``name`` is one of the following::
223 * ``--cipher-op <mode>``
225 Set cipher operation mode, where ``mode`` is one of the following::
230 * ``--cipher-key-sz <n>``
232 Set the size of cipher key.
234 * ``--cipher-iv-sz <n>``
236 Set the size of cipher iv.
238 * ``--auth-algo <name>``
240 Set authentication algorithm name, where ``name`` is one
266 * ``--auth-op <mode>``
268 Set authentication operation mode, where ``mode`` is one of
274 * ``--auth-key-sz <n>``
276 Set the size of authentication key.
278 * ``--auth-digest-sz <n>``
280 Set the size of authentication digest.
282 * ``--auth-aad-sz <n>``
284 Set the size of authentication aad.
288 Enable test result output CSV friendly rather than human friendly.
293 The test vector file is a text file contain information about test vectors.
294 The file is made of the sections. The first section doesn't have header.
295 It contain global information used in each test variant vectors -
296 typicaly information about plaintext, ciphertext, cipher key, aut key,
297 initial vector. All other sections begin header.
298 The sections contain particular information typicaly digest.
300 **Format of the file:**
302 Each line beginig with sign '#' contain comment and it is ignored by parser::
306 Header line is just name in square bracket::
310 Data line contain information tocken then sign '=' and
311 a string of bytes in C byte array format::
313 <tocken> = <C byte array>
319 Original plaintext to be crypted.
323 Encrypted plaintext string.
327 Key used in cipher operation.
331 Key used in auth operation.
348 Call application for performance throughput test of single Aesni MB PMD
349 for cipher encryption aes-cbc and auth generation sha1-hmac,
350 one milion operations, burst size 32, packet size 64::
352 dpdk-test-crypto-perf -l 6-7 --vdev crypto_aesni_mb_pmd -w 0000:00:00.0 --
353 --ptest throughput --devtype crypto_aesni_mb --optype cipher-then-auth
354 --cipher-algo aes-cbc --cipher-op encrypt --cipher-key-sz 16 --auth-algo
355 sha1-hmac --auth-op generate --auth-key-sz 64 --auth-digest-sz 12
356 --total-ops 10000000 --burst-sz 32 --buffer-sz 64
358 Call application for performance latency test of two Aesni MB PMD executed
359 on two cores for cipher encryption aes-cbc, ten operations in silent mode::
361 dpdk-test-crypto-perf -l 4-7 --vdev crypto_aesni_mb_pmd1
362 --vdev crypto_aesni_mb_pmd2 -w 0000:00:00.0 -- --devtype crypto_aesni_mb
363 --cipher-algo aes-cbc --cipher-key-sz 16 --cipher-iv-sz 16
364 --cipher-op encrypt --optype cipher-only --silent
365 --ptest latency --total-ops 10
367 Call application for verification test of single open ssl PMD
368 for cipher encryption aes-gcm and auth generation aes-gcm,ten operations
369 in silent mode, test vector provide in file "test_aes_gcm.data"
370 with packet verification::
372 dpdk-test-crypto-perf -l 4-7 --vdev crypto_openssl -w 0000:00:00.0 --
373 --devtype crypto_openssl --cipher-algo aes-gcm --cipher-key-sz 16
374 --cipher-iv-sz 16 --cipher-op encrypt --auth-algo aes-gcm --auth-key-sz 16
375 --auth-digest-sz 16 --auth-aad-sz 16 --auth-op generate --optype aead
376 --silent --ptest verify --total-ops 10
377 --test-file test_aes_gcm.data
379 Test vector file for cipher algorithm aes cbc 256 with authorization sha::
383 0xff, 0xca, 0xfb, 0xf1, 0x38, 0x20, 0x2f, 0x7b, 0x24, 0x98, 0x26, 0x7d, 0x1d, 0x9f, 0xb3, 0x93,
384 0xd9, 0xef, 0xbd, 0xad, 0x4e, 0x40, 0xbd, 0x60, 0xe9, 0x48, 0x59, 0x90, 0x67, 0xd7, 0x2b, 0x7b,
385 0x8a, 0xe0, 0x4d, 0xb0, 0x70, 0x38, 0xcc, 0x48, 0x61, 0x7d, 0xee, 0xd6, 0x35, 0x49, 0xae, 0xb4,
386 0xaf, 0x6b, 0xdd, 0xe6, 0x21, 0xc0, 0x60, 0xce, 0x0a, 0xf4, 0x1c, 0x2e, 0x1c, 0x8d, 0xe8, 0x7b
388 0x77, 0xF9, 0xF7, 0x7A, 0xA3, 0xCB, 0x68, 0x1A, 0x11, 0x70, 0xD8, 0x7A, 0xB6, 0xE2, 0x37, 0x7E,
389 0xD1, 0x57, 0x1C, 0x8E, 0x85, 0xD8, 0x08, 0xBF, 0x57, 0x1F, 0x21, 0x6C, 0xAD, 0xAD, 0x47, 0x1E,
390 0x0D, 0x6B, 0x79, 0x39, 0x15, 0x4E, 0x5B, 0x59, 0x2D, 0x76, 0x87, 0xA6, 0xD6, 0x47, 0x8F, 0x82,
391 0xB8, 0x51, 0x91, 0x32, 0x60, 0xCB, 0x97, 0xDE, 0xBE, 0xF0, 0xAD, 0xFC, 0x23, 0x2E, 0x22, 0x02
393 0xE4, 0x23, 0x33, 0x8A, 0x35, 0x64, 0x61, 0xE2, 0x49, 0x03, 0xDD, 0xC6, 0xB8, 0xCA, 0x55, 0x7A,
394 0xd0, 0xe7, 0x4b, 0xfb, 0x5d, 0xe5, 0x0c, 0xe7, 0x6f, 0x21, 0xb5, 0x52, 0x2a, 0xbb, 0xc7, 0xf7
396 0xaf, 0x96, 0x42, 0xf1, 0x8c, 0x50, 0xdc, 0x67, 0x1a, 0x43, 0x47, 0x62, 0xc7, 0x04, 0xab, 0x05,
397 0xf5, 0x0c, 0xe7, 0xa2, 0xa6, 0x23, 0xd5, 0x3d, 0x95, 0xd8, 0xcd, 0x86, 0x79, 0xf5, 0x01, 0x47,
398 0x4f, 0xf9, 0x1d, 0x9d, 0x36, 0xf7, 0x68, 0x1a, 0x64, 0x44, 0x58, 0x5d, 0xe5, 0x81, 0x15, 0x2a,
399 0x41, 0xe4, 0x0e, 0xaa, 0x1f, 0x04, 0x21, 0xff, 0x2c, 0xf3, 0x73, 0x2b, 0x48, 0x1e, 0xd2, 0xf7
401 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F
402 # Section sha 1 hmac buff 32
405 0x36, 0xCA, 0x49, 0x6A, 0xE3, 0x54, 0xD8, 0x4F, 0x0B, 0x76, 0xD8, 0xAA, 0x78, 0xEB, 0x9D, 0x65,
406 0x2C, 0xCA, 0x1F, 0x97
407 # Section sha 256 hmac buff 32
408 [sha256_hmac_buff_32]
410 0x1C, 0xB2, 0x3D, 0xD1, 0xF9, 0xC7, 0x6C, 0x49, 0x2E, 0xDA, 0x94, 0x8B, 0xF1, 0xCF, 0x96, 0x43,
411 0x67, 0x50, 0x39, 0x76, 0xB5, 0xA1, 0xCE, 0xA1, 0xD7, 0x77, 0x10, 0x07, 0x43, 0x37, 0x05, 0xB4