7. dpdk-test-crypto-perf Application

7.3.1. 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> or -l <CORELIST>

  Set the hexadecimal bitmask of the cores to run on. The corelist is a list cores to use.

• -w <PCI>

  Add a PCI device in white list.

• --vdev <driver><id>

  Add a virtual device.

7.3.2. Appication Options

The following are the appication command-line options:

• --ptest type

  Set test type, where type is one of the following:

  throughput
  latency
  verify
  pmd-cyclecount
  

• --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.

  This can be set as:

  • Single value (i.e. --burst-sz 16)
  • Range of values, using the following structure min:inc:max, where min is minimum size, inc is the increment size and max is the maximum size (i.e. --burst-sz 16:2:32)
  • List of values, up to 32 values, separated in commas (i.e. --burst-sz 16,24,32)

• --buffer-sz <n>

  Set the size of single packet (plaintext or ciphertext in it).

  This can be set as:

  • Single value (i.e. --buffer-sz 16)
  • Range of values, using the following structure min:inc:max, where min is minimum size, inc is the increment size and max is the maximum size (i.e. --buffer-sz 16:2:32)
  • List of values, up to 32 values, separated in commas (i.e. --buffer-sz 32,64,128)

• --imix <n>

  Set the distribution of packet sizes.

  A list of weights must be passed, containing the same number of items than buffer-sz, so each item in this list will be the weight of the packet size on the same position in the buffer-sz parameter (a list have to be passed in that parameter).

  Example:

  To test a distribution of 20% packets of 64 bytes, 40% packets of 100 bytes and 40% packets of 256 bytes, the command line would be: --buffer-sz 64,100,256 --imix 20,40,40. Note that the weights do not have to be percentages, so using --imix 1,2,2 would result in the same distribution

• --segment-sz <n>

  Set the size of the segment to use, for Scatter Gather List testing. By default, it is set to the size of the maximum buffer size, including the digest size, so a single segment is created.

• --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
  crypto_dpaa_sec
  crypto_dpaa2_sec
  crypto_armv8
  crypto_scheduler
  crypto_mrvl
  

• --optype <name>

  Set operation type, where name is one of the following:

  cipher-only
  auth-only
  cipher-then-auth
  auth-then-cipher
  aead
  

  For GCM/CCM algorithms you should use aead flag.

• --sessionless

  Enable session-less crypto operations mode.

• --out-of-place

  Enable out-of-place crypto operations mode.

• --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-ctr
  aes-ecb
  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-cmac
  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-iv-sz <n>

  Set the size of auth iv.

• --aead-algo <name>

  Set AEAD algorithm name, where name is one of the following:

  aes-ccm
  aes-gcm
  

• --aead-op <mode>

  Set AEAD operation mode, where mode is one of the following:

  encrypt
  decrypt
  

• --aead-key-sz <n>

  Set the size of AEAD key.

• --aead-iv-sz <n>

  Set the size of AEAD iv.

• --aead-aad-sz <n>

  Set the size of AEAD aad.

• --digest-sz <n>

  Set the size of digest.

• --desc-nb <n>

  Set number of descriptors for each crypto device.

• --pmd-cyclecount-delay-ms <n>

  Add a delay (in milliseconds) between enqueue and dequeue in pmd-cyclecount benchmarking mode (useful when benchmarking hardware acceleration).

• --csv-friendly

  Enable test result output CSV friendly rather than human friendly.

7.3.3. 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 - typically information about plaintext, ciphertext, cipher key, aut key, initial vector. All other sections begin header. The sections contain particular information typically 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.

• cipher_iv

  Cipher Initial Vector.

• auth_iv

  Auth Initial Vector.

• aad

  Additional data.

• digest

  Digest string.