d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
d91dc58356
numam-dpdk/doc/guides/cryptodevs/aesni_gcm.rst

96 lines
2.9 KiB
ReStructuredText
Raw Normal View History

doc: convert Intel license headers to SPDX tags Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-02-01 17:18:17 +00:00
.. SPDX-License-Identifier: BSD-3-Clause
crypto/aesni_gcm: use architecture independent API IPSec Multi-buffer library has recently added API that sets pointers depending on the architecture, at initiliazation, in version 0.52. AESNI MB PMD was updated with these changes, but not the AESNI GCM PMD, which also uses the same library. This makes the PMD to be only compatible with version 0.52, but makes both PMD consistent on version compatibility, plus adds support for AVX512. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2019-04-10 00:41:34 +00:00
Copyright(c) 2016-2019 Intel Corporation.
aesni_gcm: add driver for AES-GCM crypto operations This patch provides the implementation of an AES-NI accelerated crypto PMD which is dependent on Intel's multi-buffer library, see the white paper "Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors" This PMD supports AES_GCM authenticated encryption and authenticated decryption using 128-bit AES keys The patch also contains the related unit tests functions Signed-off-by: Declan Doherty <declan.doherty@intel.com> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John Griffin <john.griffin@intel.com>
2016-03-10 16:41:46 +00:00
AES-NI GCM Crypto Poll Mode Driver
doc: fix typos in crypto titles Fixes: eec136f3c54f ("aesni_gcm: add driver for AES-GCM crypto operations") Fixes: 94b0ad8e0aa5 ("null_crypto: add driver for null crypto operations") Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2016-04-04 13:14:35 +00:00
==================================
aesni_gcm: add driver for AES-GCM crypto operations This patch provides the implementation of an AES-NI accelerated crypto PMD which is dependent on Intel's multi-buffer library, see the white paper "Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors" This PMD supports AES_GCM authenticated encryption and authenticated decryption using 128-bit AES keys The patch also contains the related unit tests functions Signed-off-by: Declan Doherty <declan.doherty@intel.com> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John Griffin <john.griffin@intel.com>
2016-03-10 16:41:46 +00:00
The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation
to learn more about it, including installation).
aesni_gcm: add driver for AES-GCM crypto operations This patch provides the implementation of an AES-NI accelerated crypto PMD which is dependent on Intel's multi-buffer library, see the white paper "Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors" This PMD supports AES_GCM authenticated encryption and authenticated decryption using 128-bit AES keys The patch also contains the related unit tests functions Signed-off-by: Declan Doherty <declan.doherty@intel.com> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John Griffin <john.griffin@intel.com>
2016-03-10 16:41:46 +00:00
Features
--------
AESNI GCM PMD has support for:
Authentication algorithms:
crypto/aesni_gcm: migrate from MB library to ISA-L Current Cryptodev AES-NI GCM PMD is implemented using Multi Buffer Crypto library.This patch reimplement the device using ISA-L Crypto library: https://github.com/01org/isa-l_crypto. The migration entailed the following additional support for: * GMAC algorithm. * 256-bit cipher key. * Session-less mode. * Out-of place processing * Scatter-gatter support for chained mbufs (only out-of place and destination mbuf must be contiguous) Signed-off-by: Piotr Azarewicz <piotrx.t.azarewicz@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-01-17 11:19:18 +00:00
* RTE_CRYPTO_AUTH_AES_GMAC
cryptodev: use AES-GCM/CCM as AEAD algorithms Now that all the structures/functions for AEAD algorithms are in place, migrate the two supported algorithms AES-GCM and AES-CCM to these, instead of using cipher and authentication parameters. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com> Acked-by: Akhil Goyal <akhil.goyal@nxp.com> Acked-by: Fiona Trahe <fiona.trahe@intel.com>
2017-07-02 05:41:26 +00:00
AEAD algorithms:
* RTE_CRYPTO_AEAD_AES_GCM
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
Limitations
-----------
* Chained mbufs are supported but only out-of-place (destination mbuf must be contiguous).
doc: fix AESNI-GCM limitations in crypto guide This patch fixes the aesni-gcm cryptodev documentation by filling the lacked unsupported chained mbuf description. Fixes: 6f16aab09a91 ("crypto/aesni_gcm: migrate to Multi-buffer library") Cc: stable@dpdk.org Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
2019-09-17 12:06:46 +00:00
* Chained mbufs are only supported by RTE_CRYPTO_AEAD_AES_GCM algorithm,
not RTE_CRYPTO_AUTH_AES_GMAC.
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
* Cipher only is not supported.
crypto/aesni_gcm: migrate from MB library to ISA-L Current Cryptodev AES-NI GCM PMD is implemented using Multi Buffer Crypto library.This patch reimplement the device using ISA-L Crypto library: https://github.com/01org/isa-l_crypto. The migration entailed the following additional support for: * GMAC algorithm. * 256-bit cipher key. * Session-less mode. * Out-of place processing * Scatter-gatter support for chained mbufs (only out-of place and destination mbuf must be contiguous) Signed-off-by: Piotr Azarewicz <piotrx.t.azarewicz@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-01-17 11:19:18 +00:00
Installation
------------
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer
library from `here <https://github.com/01org/intel-ipsec-mb>`_
and compile it on their user system before building DPDK.
doc: support IPsec Multi-buffer lib v0.53 Updated AESNI MB and AESNI GCM PMD documentation guides with information about the latest Intel IPSec Multi-buffer library supported. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2019-11-04 09:32:46 +00:00
The latest version of the library supported by this PMD is v0.53, which
can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.53.zip>`_.
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
.. code-block:: console
crypto/aesni_gcm: support IPsec Multi-buffer lib v0.49 Adds support for the v0.49 of the IPsec Multi-buffer lib, which now gets compiled and installed as a shared object. Therefore, there is no need to pass the AESNI_MULTI_BUFFER_LIB_PATH Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2018-03-27 12:14:30 +00:00
make
make install
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
As a reference, the following table shows a mapping between the past DPDK versions
and the external crypto libraries supported by them:
.. _table_aesni_gcm_versions:
.. table:: DPDK and external crypto library version compatibility
============= ================================
DPDK version Crypto library version
============= ================================
16.04 - 16.11 Multi-buffer library 0.43 - 0.44
17.02 - 17.05 ISA-L Crypto v2.18
crypto/aesni_gcm: support IPsec Multi-buffer lib v0.49 Adds support for the v0.49 of the IPsec Multi-buffer lib, which now gets compiled and installed as a shared object. Therefore, there is no need to pass the AESNI_MULTI_BUFFER_LIB_PATH Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2018-03-27 12:14:30 +00:00
17.08 - 18.02 Multi-buffer library 0.46 - 0.48
crypto/aesni_gcm: use architecture independent API IPSec Multi-buffer library has recently added API that sets pointers depending on the architecture, at initiliazation, in version 0.52. AESNI MB PMD was updated with these changes, but not the AESNI GCM PMD, which also uses the same library. This makes the PMD to be only compatible with version 0.52, but makes both PMD consistent on version compatibility, plus adds support for AVX512. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2019-04-10 00:41:34 +00:00
18.05 - 19.02 Multi-buffer library 0.49 - 0.52
doc: support IPsec Multi-buffer lib v0.53 Updated AESNI MB and AESNI GCM PMD documentation guides with information about the latest Intel IPSec Multi-buffer library supported. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2019-11-04 09:32:46 +00:00
19.05+ Multi-buffer library 0.52 - 0.53
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
============= ================================
aesni_gcm: add driver for AES-GCM crypto operations This patch provides the implementation of an AES-NI accelerated crypto PMD which is dependent on Intel's multi-buffer library, see the white paper "Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors" This PMD supports AES_GCM authenticated encryption and authenticated decryption using 128-bit AES keys The patch also contains the related unit tests functions Signed-off-by: Declan Doherty <declan.doherty@intel.com> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John Griffin <john.griffin@intel.com>
2016-03-10 16:41:46 +00:00
doc: add initialization section for crypto vdevs Explain how to create/initialize virtual crypto PMDs, through command line and within an application. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2016-04-04 13:14:37 +00:00
Initialization
--------------
In order to enable this virtual crypto PMD, user must:
crypto/aesni_gcm: migrate to Multi-buffer library Since Intel Multi Buffer library for IPSec has been updated to support Scatter Gather List, the AESNI GCM PMD can link to this library, instead of the ISA-L library. This move eases the maintenance of the driver, as it will use the same library as the AESNI MB PMD. It also adds support for 192-bit keys. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2017-07-04 00:12:40 +00:00
* Build the multi buffer library (explained in Installation section).
doc: add initialization section for crypto vdevs Explain how to create/initialize virtual crypto PMDs, through command line and within an application. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2016-04-04 13:14:37 +00:00
* Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base.
To use the PMD in an application, user must:
vdev: remove eal prefix The VDEV code will move to the bus drivers directory. Rename functions from rte_eal_vdev_ to rte_vdev_ to prepare the move of the driver out of EAL. The prefix rte_eal_vdrv_ is also renamed to rte_vdev_. It was used for registration of vdev drivers. Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: Stephen Hemminger <stephen@networkplumber.org>
2017-05-04 16:01:19 +00:00
* Call rte_vdev_init("crypto_aesni_gcm") within the application.
doc: add initialization section for crypto vdevs Explain how to create/initialize virtual crypto PMDs, through command line and within an application. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2016-04-04 13:14:37 +00:00
vdev: remove eal prefix The VDEV code will move to the bus drivers directory. Rename functions from rte_eal_vdev_ to rte_vdev_ to prepare the move of the driver out of EAL. The prefix rte_eal_vdrv_ is also renamed to rte_vdev_. It was used for registration of vdev drivers. Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: Stephen Hemminger <stephen@networkplumber.org>
2017-05-04 16:01:19 +00:00
* Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_vdev_init() internally.
doc: add initialization section for crypto vdevs Explain how to create/initialize virtual crypto PMDs, through command line and within an application. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2016-04-04 13:14:37 +00:00
The following parameters (all optional) can be provided in the previous two calls:
* socket_id: Specify the socket where the memory for the device is going to be allocated
(by default, socket_id will be the socket where the core that is creating the PMD is running on).
* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
Example:
.. code-block:: console
doc: complete crypto sample command line Documentation of some virtual crypto PMDs have a sample command line to show how to initialize the device on a specific application, L2fwd-crypto. This was meant to be used as a reference, but these lines themselves do not work, as the sample application used required more parameters, which are added in this commit to have a fully functional example. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-07-26 00:59:59 +00:00
./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
-- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"
Reference in New Issue Copy Permalink