[v3] doc: support IPsec Multi-buffer lib v1.3
Checks
Commit Message
Updated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G 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>
Acked-by: Ciara Power <ciara.power@intel.com>
---
-v3: Fixed library version from 1.2 to 1.3 in one line
-v2: Removed repeated word 'the'
---
doc/guides/cryptodevs/aesni_gcm.rst | 8 ++++----
doc/guides/cryptodevs/aesni_mb.rst | 20 +++++++++++++-------
doc/guides/cryptodevs/kasumi.rst | 15 +++++++++++----
doc/guides/cryptodevs/snow3g.rst | 15 +++++++++++----
doc/guides/cryptodevs/zuc.rst | 14 ++++++++++----
5 files changed, 49 insertions(+), 23 deletions(-)
Comments
Hi Pablo,
> -----Original Message-----
> From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> Sent: Thursday, November 10, 2022 11:07 AM
> To: Ji, Kai <kai.ji@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> Power, Ciara <ciara.power@intel.com>
> Subject: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
>
> Updated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G 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>
> Acked-by: Ciara Power <ciara.power@intel.com>
>
> ---
> -v3: Fixed library version from 1.2 to 1.3 in one line
> -v2: Removed repeated word 'the'
> ---
>
<snip>
Acked-by: Brian Dooley <brian.dooley@intel.com>
Do we need to add the section about chacha-poly PMD ?
is that chacha-poly has a better performance in AESNI PMD compare to Chacha PMD ?
regards
Kai
> -----Original Message-----
> From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Sent: Thursday, November 10, 2022 11:07 AM
> To: Ji, Kai <kai.ji@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> Power, Ciara <ciara.power@intel.com>
> Subject: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
>
> Updated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G 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>
> Acked-by: Ciara Power <ciara.power@intel.com>
>
> ---
> -v3: Fixed library version from 1.2 to 1.3 in one line
> -v2: Removed repeated word 'the'
> ---
Hi Pablo,
On 11/10/2022 11:07 AM, Pablo de Lara wrote:
> Updated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G 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>
> Acked-by: Ciara Power <ciara.power@intel.com>
>
> ---
> -v3: Fixed library version from 1.2 to 1.3 in one line
> -v2: Removed repeated word 'the'
> ---
>
This to me is a great change that formally recommending one PMD over the
other for performance reason.
Do you think release notes should be updated to shut out this change?
Regards,
Fan
Other than that
Acked-by: Fan Zhang <fanzhang.oss@gmail.com>
Hi Kai,
> -----Original Message-----
> From: Ji, Kai <kai.ji@intel.com>
> Sent: Thursday, November 10, 2022 11:40 AM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Cc: dev@dpdk.org; Power, Ciara <ciara.power@intel.com>
> Subject: RE: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
>
> Do we need to add the section about chacha-poly PMD ?
> is that chacha-poly has a better performance in AESNI PMD compare to
> Chacha PMD ?
Sure, I'll add some info on that.
Thanks,
Pablo
>
> regards
>
> Kai
>
> > -----Original Message-----
> > From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> > Sent: Thursday, November 10, 2022 11:07 AM
> > To: Ji, Kai <kai.ji@intel.com>
> > Cc: dev@dpdk.org; De Lara Guarch, Pablo
> > <pablo.de.lara.guarch@intel.com>; Power, Ciara <ciara.power@intel.com>
> > Subject: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
> >
> > Updated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G 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>
> > Acked-by: Ciara Power <ciara.power@intel.com>
> >
> > ---
> > -v3: Fixed library version from 1.2 to 1.3 in one line
> > -v2: Removed repeated word 'the'
> > ---
@@ -40,8 +40,8 @@ Installation
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.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
.. code-block:: console
@@ -84,8 +84,8 @@ and the external crypto libraries supported by them:
17.08 - 18.02 Multi-buffer library 0.46 - 0.48
18.05 - 19.02 Multi-buffer library 0.49 - 0.52
19.05 - 20.08 Multi-buffer library 0.52 - 0.55
- 20.11 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.11 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2015-2018 Intel Corporation.
-AESN-NI Multi Buffer Crypto Poll Mode Driver
+AES-NI Multi Buffer Crypto Poll Mode Driver
============================================
@@ -10,8 +10,6 @@ support for utilizing Intel multi buffer library, see the white paper
`Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors
<https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_.
-The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc.
-
The AES-NI MB PMD supports synchronous mode of operation with
``rte_cryptodev_sym_cpu_crypto_process`` function call.
@@ -77,6 +75,14 @@ Limitations
* RTE_CRYPTO_CIPHER_DES_DOCSISBPI is not supported for combined Crypto-CRC
DOCSIS security protocol.
+AESNI MB PMD selection over SNOW3G/ZUC/KASUMI PMDs
+--------------------------------------------------
+
+This PMD supports wireless cipher suite (SNOW3G, ZUC and KASUMI).
+On Intel processors, it is recommended to use this PMD instead of SNOW3G, ZUC and KASUMI PMDs,
+as it enables algorithm mixing (e.g. cipher algorithm SNOW3G-UEA2 with
+authentication algorithm AES-CMAC-128) and performance over IMIX (packet size mix) traffic
+is significantly higher.
Installation
------------
@@ -84,8 +90,8 @@ Installation
To build DPDK with the AESNI_MB_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.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
.. code-block:: console
@@ -130,8 +136,8 @@ and the Multi-Buffer library version supported by them:
18.05 - 19.02 0.49 - 0.52
19.05 - 19.08 0.52
19.11 - 20.08 0.52 - 0.55
- 20.11 - 21.08 0.53 - 1.2*
- 21.11+ 1.0 - 1.2*
+ 20.11 - 21.08 0.53 - 1.3*
+ 21.11+ 1.0 - 1.3*
============== ============================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
@@ -30,14 +30,21 @@ Limitations
(if length and/or offset of data to be ciphered is not byte-aligned).
+KASUMI PMD vs AESNI MB PMD
+--------------------------
+
+AESNI MB PMD also supports KASUMI cipher and authentication algorithms,
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
+
Installation
------------
To build DPDK with the KASUMI_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.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
After downloading the library, the user needs to unpack and compile it
on their system before building DPDK:
@@ -78,8 +85,8 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.11 - 19.11 LibSSO KASUMI
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
@@ -29,6 +29,13 @@ Limitations
* In-place bit-level operations for SNOW 3G (UEA2) are not supported
(if length and/or offset of data to be ciphered is not byte-aligned).
+SNOW3G PMD vs AESNI MB PMD
+--------------------------
+
+AESNI MB PMD also supports SNOW3G cipher and authentication algorithms,
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
+
Installation
------------
@@ -37,8 +44,8 @@ library and compile it on their user system before building DPDK.
For x86 system, the multi-buffer library is available
`here <https://github.com/01org/intel-ipsec-mb>`_.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
For Arm system, ARM64 port of the multi-buffer library can be downloaded from
`<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The
@@ -83,8 +90,8 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.04 - 19.11 LibSSO SNOW3G
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
@@ -28,6 +28,12 @@ Limitations
* ZUC (EIA3) supported only if hash offset field is byte-aligned.
* ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned.
+ZUC PMD vs AESNI MB PMD
+-----------------------
+
+AESNI MB PMD also supports ZUC cipher and authentication algorithms,
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
Installation
------------
@@ -37,8 +43,8 @@ library and compile it on their user system before building DPDK.
For x86 system, the multi-buffer library is available
`here <https://github.com/01org/intel-ipsec-mb>`_.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
For Arm system, ARM64 port of the multi-buffer library can be downloaded from
`<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The
@@ -83,8 +89,8 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.11 - 19.11 LibSSO ZUC
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.