doc/guides/tools/cryptoperf.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2016 Intel Corporation. All rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   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
  14     distribution.
  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.
  18
  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.
  30
  31 dpdk-test-crypto-perf Application
  32 =================================
  33
  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
  42 structure.
  43
  44 Limitations
  45 -----------
  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
  53 cost measurement.
  54
  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.
  58
  59 Compiling the Application
  60 -------------------------
  61
  62 **Step 1: PMD setting**
  63
  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::
  67
  68    CONFIG_RTE_LIBRTE_PMD_<name>=y
  69
  70 Setting example for open ssl PMD::
  71
  72    CONFIG_RTE_LIBRTE_PMD_OPENSSL=y
  73
  74 **Step 2: Linearization setting**
  75
  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.
  79
  80 To set on the linearization options add below definition to the
  81 ``cperf_ops.h`` file::
  82
  83    #define CPERF_LINEARIZATION_ENABLE
  84
  85 **Step 3: Build the application**
  86
  87 Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
  88 ``dpdk-test-crypto-perf`` applcation.
  89
  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.
  95
  96 Running the Application
  97 -----------------------
  98
  99 The tool application has a number of command line options:
 100
 101 .. code-block:: console
 102
 103    dpdk-test-crypto-perf [EAL Options] -- [Application Options]
 104
 105 EAL Options
 106 ~~~~~~~~~~~
 107
 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.
 111
 112 *   ``-c <COREMASK>`` or ``-l <CORELIST>``
 113
 114         Set the hexadecimal bitmask of the cores to run on. The corelist is a
 115         list cores to use.
 116
 117 *   ``-w <PCI>``
 118
 119         Add a PCI device in white list.
 120
 121 *   ``--vdev <driver><id>``
 122
 123         Add a virtual device.
 124
 125 Appication Options
 126 ~~~~~~~~~~~~~~~~~~
 127
 128 The following are the appication command-line options:
 129
 130 * ``--ptest type``
 131
 132         Set test type, where ``type`` is one of the following::
 133
 134            throughput
 135            latency
 136
 137 * ``--silent``
 138
 139         Disable options dump.
 140
 141 * ``--pool-sz <n>``
 142
 143         Set the number of mbufs to be allocated in the mbuf pool.
 144
 145 * ``--total-ops <n>``
 146
 147         Set the number of total operations performed.
 148
 149 * ``--burst-sz <n>``
 150
 151         Set the number of packets per burst.
 152
 153 * ``--buffer-sz <n>``
 154
 155         Set the size of single packet (plaintext or ciphertext in it).
 156
 157 * ``--segments-nb <n>``
 158
 159         Set the number of segments per packet.
 160
 161 * ``--devtype <name>``
 162
 163         Set device type, where ``name`` is one of the following::
 164
 165            crypto_null
 166            crypto_aesni_mb
 167            crypto_aesni_gcm
 168            crypto_openssl
 169            crypto_qat
 170            crypto_snow3g
 171            crypto_kasumi
 172            crypto_zuc
 173
 174 * ``--optype <name>``
 175
 176         Set operation type, where ``name`` is one of the following::
 177
 178            cipher-only
 179            auth-only
 180            cipher-then-auth
 181            auth-then-cipher
 182            aead
 183
 184         For GCM/CCM algorithms you should use aead flag.
 185
 186 * ``--sessionless``
 187
 188         Enable session-less crypto operations mode.
 189
 190 * ``--out-of-place``
 191
 192         Enable out-of-place crypto operations mode.
 193
 194 * ``--verify``
 195
 196         Enable verify that all crypto operations were successful.
 197         The verification is done after the performance test.
 198
 199 * ``--test-file <name>``
 200
 201         Set test vector file path. See the Test Vector File chapter.
 202
 203 * ``--test-name <name>``
 204
 205         Set specific test name section in the test vector file.
 206
 207 * ``--cipher-algo <name>``
 208
 209         Set cipher algorithm name, where ``name`` is one of the following::
 210
 211            3des-cbc
 212            3des-ecb
 213            3des-ctr
 214            aes-cbc
 215            aes-ccm
 216            aes-ctr
 217            aes-ecb
 218            aes-gcm
 219            aes-f8
 220            aes-xts
 221            arc4
 222            null
 223            kasumi-f8
 224            snow3g-uea2
 225            zuc-eea3
 226
 227 * ``--cipher-op <mode>``
 228
 229         Set cipher operation mode, where ``mode`` is one of the following::
 230
 231            encrypt
 232            decrypt
 233
 234 * ``--cipher-key-sz <n>``
 235
 236         Set the size of cipher key.
 237
 238 * ``--cipher-iv-sz <n>``
 239
 240         Set the size of cipher iv.
 241
 242 * ``--auth-algo <name>``
 243
 244         Set authentication algorithm name, where ``name`` is one
 245         of the following::
 246
 247            3des-cbc
 248            aes-cbc-mac
 249            aes-ccm
 250            aes-cmac
 251            aes-gcm
 252            aes-gmac
 253            aes-xcbc-mac
 254            md5
 255            md5-hmac
 256            sha1
 257            sha1-hmac
 258            sha2-224
 259            sha2-224-hmac
 260            sha2-256
 261            sha2-256-hmac
 262            sha2-384
 263            sha2-384-hmac
 264            sha2-512
 265            sha2-512-hmac
 266            kasumi-f9
 267            snow3g-uia2
 268            zuc-eia3
 269
 270 * ``--auth-op <mode>``
 271
 272         Set authentication operation mode, where ``mode`` is one of
 273         the following::
 274
 275            verify
 276            generate
 277
 278 * ``--auth-key-sz <n>``
 279
 280         Set the size of authentication key.
 281
 282 * ``--auth-digest-sz <n>``
 283
 284         Set the size of authentication digest.
 285
 286 * ``--auth-aad-sz <n>``
 287
 288         Set the size of authentication aad.
 289
 290 * ``--csv-friendly``
 291
 292         Enable test result output CSV friendly rather than human friendly.
 293
 294 Test Vector File
 295 ~~~~~~~~~~~~~~~~
 296
 297 The test vector file is a text file contain information about test vectors.
 298 The file is made of the sections. The first section doesn't have header.
 299 It contain global information used in each test variant vectors -
 300 typicaly information about plaintext, ciphertext, cipher key, aut key,
 301 initial vector. All other sections begin header.
 302 The sections contain particular information typicaly digest.
 303
 304 **Format of the file:**
 305
 306 Each line beginig with sign '#' contain comment and it is ignored by parser::
 307
 308    # <comment>
 309
 310 Header line is just name in square bracket::
 311
 312    [<section name>]
 313
 314 Data line contain information tocken then sign '=' and
 315 a string of bytes in C byte array format::
 316
 317    <tocken> = <C byte array>
 318
 319 **Tockens list:**
 320
 321 * ``plaintext``
 322
 323         Original plaintext to be crypted.
 324
 325 * ``ciphertext``
 326
 327         Encrypted plaintext string.
 328
 329 * ``cipher_key``
 330
 331         Key used in cipher operation.
 332
 333 * ``auth_key``
 334
 335         Key used in auth operation.
 336
 337 * ``iv``
 338
 339         Initial vector.
 340
 341 * ``aad``
 342
 343         Additional data.
 344
 345 * ``digest``
 346
 347         Digest string.
 348
 349 Examples
 350 --------
 351
 352 Call application for performance throughput test of single Aesni MB PMD
 353 for cipher encryption aes-cbc and auth generation sha1-hmac,
 354 one milion operations, burst size 32, packet size 64::
 355
 356    dpdk-test-crypto-perf -l 6-7 --vdev crypto_aesni_mb_pmd -w 0000:00:00.0 --
 357    --ptest throughput --devtype crypto_aesni_mb --optype cipher-then-auth
 358    --cipher-algo aes-cbc --cipher-op encrypt --cipher-key-sz 16 --auth-algo
 359    sha1-hmac --auth-op generate --auth-key-sz 64 --auth-digest-sz 12
 360    --total-ops 10000000 --burst-sz 32 --buffer-sz 64
 361
 362 Call application for performance latency test of two Aesni MB PMD executed
 363 on two cores for cipher encryption aes-cbc, ten operations in silent mode::
 364
 365    dpdk-test-crypto-perf -l 4-7 --vdev crypto_aesni_mb_pmd1
 366    --vdev crypto_aesni_mb_pmd2 -w 0000:00:00.0 -- --devtype crypto_aesni_mb
 367    --cipher-algo aes-cbc --cipher-key-sz 16 --cipher-iv-sz 16
 368    --cipher-op encrypt --optype cipher-only --silent
 369    --ptest latency --total-ops 10
 370
 371 Call application for performance latency test of single open ssl PMD
 372 for cipher encryption aes-gcm and auth generation aes-gcm,ten operations
 373 in silent mode, test vector provide in file "test_aes_gcm.data"
 374 with packet verification::
 375
 376    dpdk-test-crypto-perf -l 4-7 --vdev crypto_openssl -w 0000:00:00.0 --
 377    --devtype crypto_openssl --cipher-algo aes-gcm --cipher-key-sz 16
 378    --cipher-iv-sz 16 --cipher-op encrypt --auth-algo aes-gcm --auth-key-sz 16
 379    --auth-digest-sz 16 --auth-aad-sz 16 --auth-op generate --optype aead
 380    --silent --ptest latency --total-ops 10
 381    --test-file test_aes_gcm.data --verify
 382
 383 Test vector file for cipher algorithm aes cbc 256 with authorization sha::
 384
 385    # Global Section
 386    plaintext =
 387    0xff, 0xca, 0xfb, 0xf1, 0x38, 0x20, 0x2f, 0x7b, 0x24, 0x98, 0x26, 0x7d, 0x1d, 0x9f, 0xb3, 0x93,
 388    0xd9, 0xef, 0xbd, 0xad, 0x4e, 0x40, 0xbd, 0x60, 0xe9, 0x48, 0x59, 0x90, 0x67, 0xd7, 0x2b, 0x7b,
 389    0x8a, 0xe0, 0x4d, 0xb0, 0x70, 0x38, 0xcc, 0x48, 0x61, 0x7d, 0xee, 0xd6, 0x35, 0x49, 0xae, 0xb4,
 390    0xaf, 0x6b, 0xdd, 0xe6, 0x21, 0xc0, 0x60, 0xce, 0x0a, 0xf4, 0x1c, 0x2e, 0x1c, 0x8d, 0xe8, 0x7b
 391    ciphertext =
 392    0x77, 0xF9, 0xF7, 0x7A, 0xA3, 0xCB, 0x68, 0x1A, 0x11, 0x70, 0xD8, 0x7A, 0xB6, 0xE2, 0x37, 0x7E,
 393    0xD1, 0x57, 0x1C, 0x8E, 0x85, 0xD8, 0x08, 0xBF, 0x57, 0x1F, 0x21, 0x6C, 0xAD, 0xAD, 0x47, 0x1E,
 394    0x0D, 0x6B, 0x79, 0x39, 0x15, 0x4E, 0x5B, 0x59, 0x2D, 0x76, 0x87, 0xA6, 0xD6, 0x47, 0x8F, 0x82,
 395    0xB8, 0x51, 0x91, 0x32, 0x60, 0xCB, 0x97, 0xDE, 0xBE, 0xF0, 0xAD, 0xFC, 0x23, 0x2E, 0x22, 0x02
 396    cipher_key =
 397    0xE4, 0x23, 0x33, 0x8A, 0x35, 0x64, 0x61, 0xE2, 0x49, 0x03, 0xDD, 0xC6, 0xB8, 0xCA, 0x55, 0x7A,
 398    0xd0, 0xe7, 0x4b, 0xfb, 0x5d, 0xe5, 0x0c, 0xe7, 0x6f, 0x21, 0xb5, 0x52, 0x2a, 0xbb, 0xc7, 0xf7
 399    auth_key =
 400    0xaf, 0x96, 0x42, 0xf1, 0x8c, 0x50, 0xdc, 0x67, 0x1a, 0x43, 0x47, 0x62, 0xc7, 0x04, 0xab, 0x05,
 401    0xf5, 0x0c, 0xe7, 0xa2, 0xa6, 0x23, 0xd5, 0x3d, 0x95, 0xd8, 0xcd, 0x86, 0x79, 0xf5, 0x01, 0x47,
 402    0x4f, 0xf9, 0x1d, 0x9d, 0x36, 0xf7, 0x68, 0x1a, 0x64, 0x44, 0x58, 0x5d, 0xe5, 0x81, 0x15, 0x2a,
 403    0x41, 0xe4, 0x0e, 0xaa, 0x1f, 0x04, 0x21, 0xff, 0x2c, 0xf3, 0x73, 0x2b, 0x48, 0x1e, 0xd2, 0xf7
 404    iv =
 405    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F
 406    # Section sha 1 hmac buff 32
 407    [sha1_hmac_buff_32]
 408    digest =
 409    0x36, 0xCA, 0x49, 0x6A, 0xE3, 0x54, 0xD8, 0x4F, 0x0B, 0x76, 0xD8, 0xAA, 0x78, 0xEB, 0x9D, 0x65,
 410    0x2C, 0xCA, 0x1F, 0x97
 411    # Section sha 256 hmac buff 32
 412    [sha256_hmac_buff_32]
 413    digest =
 414    0x1C, 0xB2, 0x3D, 0xD1, 0xF9, 0xC7, 0x6C, 0x49, 0x2E, 0xDA, 0x94, 0x8B, 0xF1, 0xCF, 0x96, 0x43,
 415    0x67, 0x50, 0x39, 0x76, 0xB5, 0xA1, 0xCE, 0xA1, 0xD7, 0x77, 0x10, 0x07, 0x43, 0x37, 0x05, 0xB4