Re: [dpdk-dev] [PATCH v4 0/7] crypto: add virtio poll mode driver

["Zhoujian (jay)" <jianjay.zhou@huawei.com>]

I find that my dpdk-next-crypto repo is not the newest, I'll send a new version.
Sorry about that.

Regards,
Jay

> -----Original Message-----
> From: Zhoujian (jay)
> Sent: Saturday, March 31, 2018 3:49 PM
> To: dev@dpdk.org
> Cc: pablo.de.lara.guarch@intel.com; roy.fan.zhang@intel.com;
> thomas@monjalon.net; Gonglei (Arei) <arei.gonglei@huawei.com>;
> xin.zeng@intel.com; Huangweidong (C) <weidong.huang@huawei.com>; wangxin (U)
> <wangxinxin.wang@huawei.com>; longpeng <longpeng2@huawei.com>; Zhoujian (jay)
> <jianjay.zhou@huawei.com>
> Subject: [PATCH v4 0/7] 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 sent to DPDK community, pls see
> 
> [PATCH v2 00/10] lib/librte_vhost: introduce new vhost user crypto backend
> support https://dpdk.org/ml/archives/dev/2018-February/091594.html
> 
> 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
>   8) TestCase AES-128-CTR Encryption PASS
>   9) TestCase AES-128-CTR Decryption PASS
>   10) TestCase AES-192-CTR Encryption PASS
>   11) TestCase AES-192-CTR Decryption PASS
>   12) TestCase AES-256-CTR Encryption PASS
>   13) TestCase AES-256-CTR 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 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 (7):
>   crypto/virtio: add virtio related fundamental functions
>   crypto/virtio: add crypto related session structure
>   crypto/virtio: core code of virtio crypto PMD
>   crypto/virtio: add makefile
>   doc: add virtio crypto PMD guide
>   test/crypto: add function tests for virtio crypto PMD
>   MAINTAINERS: add myself as virtio crypto PMD maintainer
> 
>  MAINTAINERS                                        |    6 +
>  config/common_base                                 |   14 +
>  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             |    4 +
>  drivers/crypto/Makefile                            |    1 +
>  drivers/crypto/virtio/Makefile                     |   31 +
>  .../virtio/rte_pmd_virtio_crypto_version.map       |    3 +
>  drivers/crypto/virtio/virtio_crypto_algs.h         |   27 +
>  drivers/crypto/virtio/virtio_crypto_capabilities.h |   51 +
>  drivers/crypto/virtio/virtio_cryptodev.c           | 1508
> ++++++++++++++++++++
>  drivers/crypto/virtio/virtio_cryptodev.h           |   66 +
>  drivers/crypto/virtio/virtio_logs.h                |   91 ++
>  drivers/crypto/virtio/virtio_pci.c                 |  460 ++++++
>  drivers/crypto/virtio/virtio_pci.h                 |  253 ++++
>  drivers/crypto/virtio/virtio_ring.h                |  137 ++
>  drivers/crypto/virtio/virtio_rxtx.c                |  541 +++++++
>  drivers/crypto/virtio/virtqueue.c                  |   43 +
>  drivers/crypto/virtio/virtqueue.h                  |  172 +++
>  mk/rte.app.mk                                      |    1 +
>  test/test/test_cryptodev.c                         |   49 +
>  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 +
>  26 files changed, 3628 insertions(+), 9 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/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
> 
> --
> 1.8.3.1
>