Skip to content

crypto: add virtio poll mode driver

Jay Zhou dpdk-dev 10 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v11 Latest10 patches 2 repliesIn review
  2. v1010 patches 2 repliesSuperseded
  3. v911 patches 2 repliesSuperseded
Earlier versions · 7
VersionPostedPatchesRepliesStatus
v811 patches0 repliesSuperseded
v710 patches0 repliesSuperseded
v610 patches2 repliesSuperseded
v57 patches2 repliesSuperseded
v47 patches1 replySuperseded
v37 patches18 repliesSuperseded
v27 patches3 repliesSuperseded

Changes in v11 from the cover letter

- remove dependency on libcrypto [Pablo]
- enabled this PMD by default [Pablo]
- update path to the virtio_crypto.h file [Ferruh]

Patches in v11 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/10crypto/virtio: add virtio crypto PMDMAINTAINERS config/common_base config/rte_config.h +9 more+112 -10 replies
2/10crypto/virtio: support virtio device initdrivers/crypto/virtio/Makefile drivers/crypto/virtio/meson.build drivers/crypto/virtio/virtio_cryptodev.c +8 more+1449 -30 replies
3/10crypto/virtio: support basic PMD opsdrivers/crypto/virtio/virtio_cryptodev.c drivers/crypto/virtio/virtio_cryptodev.h drivers/crypto/virtio/virtio_rxtx.c+528 -90 replies
4/10crypto/virtio: support session related opsdrivers/crypto/virtio/virtio_crypto_algs.h drivers/crypto/virtio/virtio_cryptodev.c drivers/crypto/virtio/virtio_cryptodev.h+769 -30 replies
5/10crypto/virtio: support crypto enqueue/dequeue burst APIdrivers/crypto/virtio/virtio_cryptodev.h drivers/crypto/virtio/virtio_rxtx.c+433 -100 replies
6/10crypto/virtio: support stats related opsdrivers/crypto/virtio/virtio_cryptodev.c+64 -20 replies
7/10crypto/virtio: support AES-CBCdrivers/crypto/virtio/virtio_crypto_capabilities.h drivers/crypto/virtio/virtio_cryptodev.c+41 -00 replies
8/10crypto/virtio: support HMAC-SHA1drivers/crypto/virtio/virtio_crypto_capabilities.h drivers/crypto/virtio/virtio_cryptodev.c+24 -10 replies
9/10test/crypto: add function tests for virtio crypto PMDtest/test/test_cryptodev.c test/test/test_cryptodev.h test/test/test_cryptodev_aes_test_vectors.h +2 more+74 -90 replies
10/10doc: add virtio crypto PMD guideMAINTAINERS doc/guides/cryptodevs/features/virtio.ini doc/guides/cryptodevs/index.rst +2 more+150 -10 replies

Reviews trailers per patch

All 10 patches have a Reviewed-by or Acked-by.

PatchFan Zhang
1/10R-b A-b
2/10R-b A-b
3/10R-b A-b
4/10R-b A-b
5/10R-b A-b
6/10R-b A-b
7/10R-b A-b
8/10R-b A-b
9/10R-b A-b
10/10R-b A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v11 thread

Cover letter [PATCH v11 00/10] crypto: add virtio poll mode driver

This patch series introduce virtio crypto poll mode driver.

Since it is limited by the vhost crypto backend of the virtio-crypto, this patch series only supports a limited subset of crypto services. Only the following algorithms are tested:

Cipher algorithms:
- RTE_CRYPTO_CIPHER_AES_CBC (128-bit, 192-bit and 256-bit keys)

Cipher then hash algorithms:
- RTE_CRYPTO_CIPHER_AES_CBC with RTE_CRYPTO_AUTH_SHA1_HMAC

The qemu side has supported vhost crypto and the vhost user crypto server side patches had been merged into dpdk-next-virtio too.

Firstly run DPDK vhost crypto sample as a server side and build QEMU with vhost crypto enabled.
QEMU can then be started using the following parameters:

qemu-system-x86_64 \
    [...] \
        -chardev socket,id=charcrypto0,path=/path/to/your/socket \
        -object cryptodev-vhost-user,id=cryptodev0,chardev=charcrypto0 \
        -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0
    [...]

Bind the uio_generic driver for the virtio-crypto device. For example, 0000:00:04.0 is the domain, bus, device and function number of the virtio-crypto device:

    modprobe uio_pci_generic
    echo -n 0000:00:04.0 > /sys/bus/pci/drivers/virtio-pci/unbind
    echo "1af4 1054" > /sys/bus/pci/drivers/uio_pci_generic/new_id

The front-end virtio crypto PMD driver can be installed:
cd to the top-level DPDK directory
sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO\)=n,\1=y,' config/common_base make config T=x86_64-native-linuxapp-gcc
make install T=x86_64-native-linuxapp-gcc

The unit test cases can be compiled as below:
cd to the top-level DPDK directory
export RTE_TARGET=x86_64-native-linuxapp-gcc export RTE_SDK=pwd
cd to test/test
make
./test (MUST reserve enough huge pages memory) type the command "cryptodev_virtio_autotest" to test

The result should be like this:
RTE>>cryptodev_virtio_autotest
+ ------------------------------------------------------- +
+ Test Suite : Crypto VIRTIO Unit Test Suite
+ ------------------------------------------------------- +
0) TestCase AES-128-CBC Encryption PASS
1) TestCase AES-128-CBC Decryption PASS
2) TestCase AES-192-CBC Encryption PASS
3) TestCase AES-192-CBC Decryption PASS
4) TestCase AES-256-CBC Encryption PASS
5) TestCase AES-256-CBC Decryption PASS
6) TestCase AES-256-CBC OOP Encryption PASS
7) TestCase AES-256-CBC OOP Decryption PASS
+ TestCase [ 0] : test_AES_cipheronly_virtio_all succeeded
+ ------------------------------------------------------- +
+ Test Suite Summary

 + Tests Total :        1
 + Tests Skipped :      0
 + Tests Executed :     1
 + Tests Unsupported:   0
 + Tests Passed :       1
 + Tests Failed :       0

+ ------------------------------------------------------- +
Test OK

The performance can be tested as below:

reserve enough huge pages
cd to the top-level DPDK directory
export RTE_TARGET=x86_64-native-linuxapp-gcc
export RTE_SDK=pwd
cd to app/test-crypto-perf
type the command "make" to compile
run the tests with the following command:

./dpdk-test-crypto-perf -l 0,1 -- --devtype crypto_virtio \
--ptest throughput --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 --digest-sz 12 \
--total-ops 100000000 --burst-sz 64 --buffer-sz 2048

Please help to review, thanks!

Changes in v11:
- remove dependency on libcrypto [Pablo]
- enabled this PMD by default [Pablo]
- update path to the virtio_crypto.h file [Ferruh]

Changes in v10:
- squash the meson build files into the previous patches [Pablo]

Changes in v9:
- fix compilation error when CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO=y and CONFIG_RTE_BUILD_SHARED_LIB=y

Changes in v8:
- using the virtio_crypto.h in compat lib instead of the linux header file
- add meson build

Changes in v7:
- add detailed commit messages [Pablo]

Changes in v6:
- split the patches in a more functional way [Pablo]

Changes in v5:
- rebased on the newest dpdk-next-crypto

Changes in v4:
- using dynamic logging [Pablo]
- elaborate on the core code [Pablo]
- delete algorithms which can not be tested [Pablo]
- rebased on dpdk-next-crypto [Pablo]
- fix doc compilation error [Pablo]
- add release note for this PMD [Pablo]
- add R-b from Fan Zhang
- fix some typos

Changes in v3:
- set up capabilities for virtio crypto PMD [Fan]
- delete AES-CTR unit test cases since vhost_user crypto backend does not support [Fan]
- fix a variable uninitialized in virtio_crypto_queue_setup() [Xin, Fan]
- fix a bug in virtqueue_dequeue_burst_rx()

Changes in v2:
- using pre-allocated mempool instead of rte_malloc to improve performance [Fan]
- split the patch into a patchset [Fan]
- using linux/virtio_crypto.h instead of creating a copy of the file [Fan]
- update doc/guides/cryptodevs for describing virtio crypto PMD [Fan]
- update copyright
- delete virtio legacy mode code since virtio-crypto conforms to virtio-1.0
- refine the function and variable names
- fix errors and warnings reported by checkpatch

Jay Zhou (10):
crypto/virtio: add virtio crypto PMD crypto/virtio: support virtio device init crypto/virtio: support basic PMD ops crypto/virtio: support session related ops crypto/virtio: support crypto enqueue/dequeue burst API crypto/virtio: support stats related ops crypto/virtio: support AES-CBC
crypto/virtio: support HMAC-SHA1
test/crypto: add function tests for virtio crypto PMD
doc: add virtio crypto PMD guide

 MAINTAINERS                                        |    6 +
 config/common_base                                 |   14 +
 config/rte_config.h                                |    4 +
 doc/guides/cryptodevs/features/virtio.ini          |   26 +
 doc/guides/cryptodevs/index.rst                    |    1 +
 doc/guides/cryptodevs/virtio.rst                   |  117 ++
 doc/guides/rel_notes/release_18_05.rst             |    7 +
 drivers/crypto/Makefile                            |    1 +
 drivers/crypto/meson.build                         |    2 +-
 drivers/crypto/virtio/Makefile                     |   35 +
 drivers/crypto/virtio/meson.build                  |    8 +
 .../virtio/rte_pmd_virtio_crypto_version.map       |    3 +
 drivers/crypto/virtio/virtio_crypto_algs.h         |   28 +
 drivers/crypto/virtio/virtio_crypto_capabilities.h |   51 +
 drivers/crypto/virtio/virtio_cryptodev.c           | 1504 ++++++++++++++++++++
 drivers/crypto/virtio/virtio_cryptodev.h           |   62 +
 drivers/crypto/virtio/virtio_logs.h                |   91 ++
 drivers/crypto/virtio/virtio_pci.c                 |  462 ++++++
 drivers/crypto/virtio/virtio_pci.h                 |  253 ++++
 drivers/crypto/virtio/virtio_ring.h                |  137 ++
 drivers/crypto/virtio/virtio_rxtx.c                |  515 +++++++
 drivers/crypto/virtio/virtqueue.c                  |   43 +
 drivers/crypto/virtio/virtqueue.h                  |  171 +++
 mk/rte.app.mk                                      |    1 +
 test/test/test_cryptodev.c                         |   48 +
 test/test/test_cryptodev.h                         |    1 +
 test/test/test_cryptodev_aes_test_vectors.h        |   24 +-
 test/test/test_cryptodev_blockcipher.c             |    9 +-
 test/test/test_cryptodev_blockcipher.h             |    1 +
 29 files changed, 3615 insertions(+), 10 deletions(-)
 create mode 100644 doc/guides/cryptodevs/features/virtio.ini
 create mode 100644 doc/guides/cryptodevs/virtio.rst
 create mode 100644 drivers/crypto/virtio/Makefile
 create mode 100644 drivers/crypto/virtio/meson.build
 create mode 100644 drivers/crypto/virtio/rte_pmd_virtio_crypto_version.map
 create mode 100644 drivers/crypto/virtio/virtio_crypto_algs.h
 create mode 100644 drivers/crypto/virtio/virtio_crypto_capabilities.h
 create mode 100644 drivers/crypto/virtio/virtio_cryptodev.c
 create mode 100644 drivers/crypto/virtio/virtio_cryptodev.h
 create mode 100644 drivers/crypto/virtio/virtio_logs.h
 create mode 100644 drivers/crypto/virtio/virtio_pci.c
 create mode 100644 drivers/crypto/virtio/virtio_pci.h
 create mode 100644 drivers/crypto/virtio/virtio_ring.h
 create mode 100644 drivers/crypto/virtio/virtio_rxtx.c
 create mode 100644 drivers/crypto/virtio/virtqueue.c
 create mode 100644 drivers/crypto/virtio/virtqueue.h
Signature · 1 line
1.8.3.1