* [PATCH] doc: support IPsec Multi-buffer lib v1.3
@ 2022-11-09 18:33 Pablo de Lara
2022-11-09 18:39 ` [PATCH v2] " Pablo de Lara
0 siblings, 1 reply; 22+ messages in thread
From: Pablo de Lara @ 2022-11-09 18:33 UTC (permalink / raw)
To: kai.ji; +Cc: dev, Pablo de Lara
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>
---
doc/guides/cryptodevs/aesni_gcm.rst | 8 ++++----
doc/guides/cryptodevs/aesni_mb.rst | 18 ++++++++++++------
doc/guides/cryptodevs/kasumi.rst | 15 +++++++++++----
doc/guides/cryptodevs/snow3g.rst | 15 +++++++++++----
doc/guides/cryptodevs/zuc.rst | 14 ++++++++++----
5 files changed, 48 insertions(+), 22 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..3d0cd3de85 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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
@@ -131,7 +137,7 @@ and the Multi-Buffer library version supported by them:
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*
+ 21.11+ 1.0 - 1.3*
============== ============================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..dc3a300fb5 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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 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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..eb7e53b8a4 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -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 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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..44fc2784cd 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -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 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.
--
2.34.1
^ permalink raw reply [flat|nested] 22+ messages in thread* [PATCH v2] doc: support IPsec Multi-buffer lib v1.3
2022-11-09 18:33 [PATCH] doc: support IPsec Multi-buffer lib v1.3 Pablo de Lara
@ 2022-11-09 18:39 ` Pablo de Lara
2022-11-10 9:38 ` [EXT] " Akhil Goyal
` (2 more replies)
0 siblings, 3 replies; 22+ messages in thread
From: Pablo de Lara @ 2022-11-09 18:39 UTC (permalink / raw)
To: kai.ji; +Cc: dev, Pablo de Lara
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>
---
- v2: Removed repeated word 'the'
---
doc/guides/cryptodevs/aesni_gcm.rst | 8 ++++----
doc/guides/cryptodevs/aesni_mb.rst | 18 ++++++++++++------
doc/guides/cryptodevs/kasumi.rst | 15 +++++++++++----
doc/guides/cryptodevs/snow3g.rst | 15 +++++++++++----
doc/guides/cryptodevs/zuc.rst | 14 ++++++++++----
5 files changed, 48 insertions(+), 22 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..3d0cd3de85 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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
@@ -131,7 +137,7 @@ and the Multi-Buffer library version supported by them:
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*
+ 21.11+ 1.0 - 1.3*
============== ============================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..a27a6ea050 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..8b646dd1e0 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -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.
--
2.34.1
^ permalink raw reply [flat|nested] 22+ messages in thread* RE: [EXT] [PATCH v2] doc: support IPsec Multi-buffer lib v1.3
2022-11-09 18:39 ` [PATCH v2] " Pablo de Lara
@ 2022-11-10 9:38 ` Akhil Goyal
2022-11-10 10:43 ` Power, Ciara
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
2 siblings, 0 replies; 22+ messages in thread
From: Akhil Goyal @ 2022-11-10 9:38 UTC (permalink / raw)
To: Pablo de Lara, kai.ji; +Cc: dev
> 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>
> ---
Do you want to highlight in release notes as well?
^ permalink raw reply [flat|nested] 22+ messages in thread
* RE: [PATCH v2] doc: support IPsec Multi-buffer lib v1.3
2022-11-09 18:39 ` [PATCH v2] " Pablo de Lara
2022-11-10 9:38 ` [EXT] " Akhil Goyal
@ 2022-11-10 10:43 ` Power, Ciara
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
2 siblings, 0 replies; 22+ messages in thread
From: Power, Ciara @ 2022-11-10 10:43 UTC (permalink / raw)
To: De Lara Guarch, Pablo, Ji, Kai; +Cc: dev, De Lara Guarch, Pablo
Hi Pablo,
> -----Original Message-----
> From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> Sent: Wednesday 9 November 2022 18:39
> To: Ji, Kai <kai.ji@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Subject: [PATCH v2] 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>
> ---
>
> - v2: Removed repeated word 'the'
>
> ---
> doc/guides/cryptodevs/aesni_gcm.rst | 8 ++++----
> doc/guides/cryptodevs/aesni_mb.rst | 18 ++++++++++++------
> doc/guides/cryptodevs/kasumi.rst | 15 +++++++++++----
> doc/guides/cryptodevs/snow3g.rst | 15 +++++++++++----
> doc/guides/cryptodevs/zuc.rst | 14 ++++++++++----
> 5 files changed, 48 insertions(+), 22 deletions(-)
>
<snip>
> --- a/doc/guides/cryptodevs/aesni_mb.rst
> +++ b/doc/guides/cryptodevs/aesni_mb.rst
> @@ -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/whit
> e-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
>
> @@ -131,7 +137,7 @@ and the Multi-Buffer library version supported by
> them:
> 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*
> + 21.11+ 1.0 - 1.3*
> ============== ============================
[CP]
Should 20.11 - 21.08 be 0.53 - 1.3* also?
Overall, looks good, thanks.
Acked-by: Ciara Power <ciara.power@intel.com>
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
2022-11-09 18:39 ` [PATCH v2] " Pablo de Lara
2022-11-10 9:38 ` [EXT] " Akhil Goyal
2022-11-10 10:43 ` Power, Ciara
@ 2022-11-10 11:07 ` Pablo de Lara
2022-11-10 11:17 ` Dooley, Brian
` (3 more replies)
2 siblings, 4 replies; 22+ messages in thread
From: Pablo de Lara @ 2022-11-10 11:07 UTC (permalink / raw)
To: kai.ji; +Cc: dev, Pablo de Lara, Ciara Power
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(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..492c53f595 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..a27a6ea050 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..8b646dd1e0 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -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.
--
2.34.1
^ permalink raw reply [flat|nested] 22+ messages in thread* RE: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
@ 2022-11-10 11:17 ` Dooley, Brian
2022-11-10 11:39 ` Ji, Kai
` (2 subsequent siblings)
3 siblings, 0 replies; 22+ messages in thread
From: Dooley, Brian @ 2022-11-10 11:17 UTC (permalink / raw)
To: De Lara Guarch, Pablo, Ji, Kai; +Cc: dev, De Lara Guarch, Pablo, Power, Ciara
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>
^ permalink raw reply [flat|nested] 22+ messages in thread* RE: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
2022-11-10 11:17 ` Dooley, Brian
@ 2022-11-10 11:39 ` Ji, Kai
2022-11-11 16:24 ` De Lara Guarch, Pablo
2022-11-10 16:44 ` Zhang, Fan
2022-11-12 11:26 ` [PATCH v4] " Pablo de Lara
3 siblings, 1 reply; 22+ messages in thread
From: Ji, Kai @ 2022-11-10 11:39 UTC (permalink / raw)
To: De Lara Guarch, Pablo; +Cc: dev, Power, Ciara
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'
> ---
^ permalink raw reply [flat|nested] 22+ messages in thread
* RE: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
2022-11-10 11:39 ` Ji, Kai
@ 2022-11-11 16:24 ` De Lara Guarch, Pablo
0 siblings, 0 replies; 22+ messages in thread
From: De Lara Guarch, Pablo @ 2022-11-11 16:24 UTC (permalink / raw)
To: Ji, Kai; +Cc: dev, Power, Ciara
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'
> > ---
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
2022-11-10 11:17 ` Dooley, Brian
2022-11-10 11:39 ` Ji, Kai
@ 2022-11-10 16:44 ` Zhang, Fan
2022-11-12 11:26 ` [PATCH v4] " Pablo de Lara
3 siblings, 0 replies; 22+ messages in thread
From: Zhang, Fan @ 2022-11-10 16:44 UTC (permalink / raw)
To: Pablo de Lara, kai.ji; +Cc: dev, Ciara Power
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>
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH v4] doc: support IPsec Multi-buffer lib v1.3
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
` (2 preceding siblings ...)
2022-11-10 16:44 ` Zhang, Fan
@ 2022-11-12 11:26 ` Pablo de Lara
2022-11-14 23:34 ` Ji, Kai
2022-11-15 17:11 ` [dpdk-dev v5] " Kai Ji
3 siblings, 2 replies; 22+ messages in thread
From: Pablo de Lara @ 2022-11-12 11:26 UTC (permalink / raw)
To: kai.ji; +Cc: dev, Pablo de Lara, Ciara Power, Brian Dooley
Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G
and CHACHA20_POLY1305 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>
Acked-by: Brian Dooley <brian.dooley@intel.com>
---
-v4: Added information on CHACHA20_POLY1305 PMD guide
-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 | 29 ++++++++++++++++-----
doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++++++---
doc/guides/cryptodevs/kasumi.rst | 15 ++++++++---
doc/guides/cryptodevs/snow3g.rst | 15 ++++++++---
doc/guides/cryptodevs/zuc.rst | 14 +++++++---
6 files changed, 67 insertions(+), 26 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..b9bf03655d 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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,23 @@ 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.
+
+AESNI MB PMD selection over CHACHA20-POLY1305 PMD
+-------------------------------------------------
+
+This PMD supports Chacha20-Poly1305 algorithm.
+On Intel processors, it is recommended to use this PMD instead of CHACHA20-POLY1305 PMD,
+as it delivers better performance on single segment buffers.
+For multi-segment buffers, it is still recommended to use CHACHA20-POLY1305 PMD,
+until the new SGL API is introduced in the AESNI MB PMD.
Installation
------------
@@ -84,8 +99,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 +145,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.
diff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst b/doc/guides/cryptodevs/chacha20_poly1305.rst
index 4db260818e..7d69c4b192 100644
--- a/doc/guides/cryptodevs/chacha20_poly1305.rst
+++ b/doc/guides/cryptodevs/chacha20_poly1305.rst
@@ -16,6 +16,12 @@ AEAD algorithms:
* RTE_CRYPTO_AEAD_CHACHA20_POLY1305
+Chaha20_Poly1305 PMD vs AESNI MB PMD
+------------------------------------
+
+AESNI MB PMD also supports CHACHA20-POLY1305 algorithms.
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors, when single-segment buffers are used.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
Installation
------------
@@ -23,8 +29,8 @@ Installation
To build DPDK with the Chacha20-poly1305 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.0, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.0.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:
@@ -64,7 +70,7 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 21.11+ Multi-buffer library 1.0*
+ 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.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..a27a6ea050 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..8b646dd1e0 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -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.
--
2.37.3
^ permalink raw reply [flat|nested] 22+ messages in thread* RE: [PATCH v4] doc: support IPsec Multi-buffer lib v1.3
2022-11-12 11:26 ` [PATCH v4] " Pablo de Lara
@ 2022-11-14 23:34 ` Ji, Kai
2022-11-15 9:24 ` Akhil Goyal
2022-11-15 17:11 ` [dpdk-dev v5] " Kai Ji
1 sibling, 1 reply; 22+ messages in thread
From: Ji, Kai @ 2022-11-14 23:34 UTC (permalink / raw)
To: Akhil Goyal; +Cc: Power, Ciara, Dooley, Brian, dev, De Lara Guarch, Pablo
Hi Akhil,
I remember you have a comment in earlier version of this patch about to include this ipsec mb v1.3 release doc update into release notes.
I have review the release_22_11.rst, but I'm not sure the best section to capture this info , any recommendations ?
Best
Kai
> -----Original Message-----
> From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Sent: Saturday, November 12, 2022 11:26 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>; Dooley, Brian <brian.dooley@intel.com>
> Subject: [PATCH v4] doc: support IPsec Multi-buffer lib v1.3
>
> Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
> CHACHA20_POLY1305 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>
> Acked-by: Brian Dooley <brian.dooley@intel.com>
>
> ---
> -v4: Added information on CHACHA20_POLY1305 PMD guide
> -v3: Fixed library version from 1.2 to 1.3 in one line
> -v2: Removed repeated word 'the'
> ---
^ permalink raw reply [flat|nested] 22+ messages in thread
* RE: [PATCH v4] doc: support IPsec Multi-buffer lib v1.3
2022-11-14 23:34 ` Ji, Kai
@ 2022-11-15 9:24 ` Akhil Goyal
0 siblings, 0 replies; 22+ messages in thread
From: Akhil Goyal @ 2022-11-15 9:24 UTC (permalink / raw)
To: Ji, Kai; +Cc: Power, Ciara, Dooley, Brian, dev, De Lara Guarch, Pablo
> Hi Akhil,
>
> I remember you have a comment in earlier version of this patch about to
> include this ipsec mb v1.3 release doc update into release notes.
> I have review the release_22_11.rst, but I'm not sure the best section to capture
> this info , any recommendations ?
>
It can be added as a bullet in
240
241 * **Updated ipsec_mb crypto driver.**
242
243 Added SNOW-3G and ZUC support for ARM platform.
244
^ permalink raw reply [flat|nested] 22+ messages in thread
* [dpdk-dev v5] doc: support IPsec Multi-buffer lib v1.3
2022-11-12 11:26 ` [PATCH v4] " Pablo de Lara
2022-11-14 23:34 ` Ji, Kai
@ 2022-11-15 17:11 ` Kai Ji
2022-11-15 20:17 ` Zhang, Fan
2022-11-16 12:06 ` [dpdk-dev v6] " Kai Ji
1 sibling, 2 replies; 22+ messages in thread
From: Kai Ji @ 2022-11-15 17:11 UTC (permalink / raw)
To: dev; +Cc: gakhil, Pablo de Lara, Kai Ji
From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G
and CHACHA20_POLY1305 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>
Acked-by: Brian Dooley <brian.dooley@intel.com>
Signed-off-by: Kai Ji <kai.ji@intel.com>
---
-v5: Release notes update
-v4: Added information on CHACHA20_POLY1305 PMD guide
-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 | 29 ++++++++++++++++-----
doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++++++---
doc/guides/cryptodevs/kasumi.rst | 15 ++++++++---
doc/guides/cryptodevs/snow3g.rst | 15 ++++++++---
doc/guides/cryptodevs/zuc.rst | 14 +++++++---
doc/guides/rel_notes/release_22_11.rst | 10 ++++++-
7 files changed, 76 insertions(+), 27 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..b9bf03655d 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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,23 @@ 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.
+
+AESNI MB PMD selection over CHACHA20-POLY1305 PMD
+-------------------------------------------------
+
+This PMD supports Chacha20-Poly1305 algorithm.
+On Intel processors, it is recommended to use this PMD instead of CHACHA20-POLY1305 PMD,
+as it delivers better performance on single segment buffers.
+For multi-segment buffers, it is still recommended to use CHACHA20-POLY1305 PMD,
+until the new SGL API is introduced in the AESNI MB PMD.
Installation
------------
@@ -84,8 +99,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 +145,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.
diff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst b/doc/guides/cryptodevs/chacha20_poly1305.rst
index 4db260818e..7d69c4b192 100644
--- a/doc/guides/cryptodevs/chacha20_poly1305.rst
+++ b/doc/guides/cryptodevs/chacha20_poly1305.rst
@@ -16,6 +16,12 @@ AEAD algorithms:
* RTE_CRYPTO_AEAD_CHACHA20_POLY1305
+Chaha20_Poly1305 PMD vs AESNI MB PMD
+------------------------------------
+
+AESNI MB PMD also supports CHACHA20-POLY1305 algorithms.
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors, when single-segment buffers are used.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
Installation
------------
@@ -23,8 +29,8 @@ Installation
To build DPDK with the Chacha20-poly1305 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.0, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.0.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:
@@ -64,7 +70,7 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 21.11+ Multi-buffer library 1.0*
+ 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.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..a27a6ea050 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..8b646dd1e0 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -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.
diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 4e55b543ef..50dcdbbbeb 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -240,7 +240,15 @@ New Features
* **Updated ipsec_mb crypto driver.**
- Added SNOW-3G and ZUC support for ARM platform.
+ * Added SNOW-3G and ZUC support for ARM platform.
+ * Added Intel IPsec MB v1.3 library support, see the following guides for
+ more details:
+ :doc:`../cryptodevs/aesni_gcm`
+ :doc:`../cryptodevs/aesni_mb`
+ :doc:`../cryptodevs/chacha20_poly1305`
+ :doc:`../cryptodevs/kasumi`
+ :doc:`../cryptodevs/snow3g`
+ :doc:`../cryptodevs/zuc`
* **Added UADK crypto driver.**
--
2.17.1
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [dpdk-dev v5] doc: support IPsec Multi-buffer lib v1.3
2022-11-15 17:11 ` [dpdk-dev v5] " Kai Ji
@ 2022-11-15 20:17 ` Zhang, Fan
2022-11-16 12:06 ` [dpdk-dev v6] " Kai Ji
1 sibling, 0 replies; 22+ messages in thread
From: Zhang, Fan @ 2022-11-15 20:17 UTC (permalink / raw)
To: Kai Ji, dev; +Cc: gakhil, Pablo de Lara
Hi,
On 11/15/2022 5:11 PM, Kai Ji wrote:
> From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
>
> Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G
> and CHACHA20_POLY1305 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>
> Acked-by: Brian Dooley <brian.dooley@intel.com>
> Signed-off-by: Kai Ji <kai.ji@intel.com>
> ---
> -v5: Release notes update
> -v4: Added information on CHACHA20_POLY1305 PMD guide
> -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 | 29 ++++++++++++++++-----
> doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++++++---
> doc/guides/cryptodevs/kasumi.rst | 15 ++++++++---
> doc/guides/cryptodevs/snow3g.rst | 15 ++++++++---
> doc/guides/cryptodevs/zuc.rst | 14 +++++++---
> doc/guides/rel_notes/release_22_11.rst | 10 ++++++-
> 7 files changed, 76 insertions(+), 27 deletions(-)
<snip>
> diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
> index 4e55b543ef..50dcdbbbeb 100644
> --- a/doc/guides/rel_notes/release_22_11.rst
> +++ b/doc/guides/rel_notes/release_22_11.rst
> @@ -240,7 +240,15 @@ New Features
>
> * **Updated ipsec_mb crypto driver.**
>
> - Added SNOW-3G and ZUC support for ARM platform.
> + * Added SNOW-3G and ZUC support for ARM platform.
> + * Added Intel IPsec MB v1.3 library support, see the following guides for
> + more details:
> + :doc:`../cryptodevs/aesni_gcm`
> + :doc:`../cryptodevs/aesni_mb`
> + :doc:`../cryptodevs/chacha20_poly1305`
> + :doc:`../cryptodevs/kasumi`
> + :doc:`../cryptodevs/snow3g`
> + :doc:`../cryptodevs/zuc`
>
> * **Added UADK crypto driver.**
>
> --
> 2.17.1
This text, in conjunction with existing ARM news, looks confusing to me.
We may have to have clearer feature descriptor for both platforms from
this point.
My suggestion:
* **Updated ipsec_mb crypto driver.**
* Added ARM64 port of ipsec-mb library support and SNOW-3G and ZUC
support for ARM platform.
* Added Intel IPsec MB v1.3 library support for x86 and ARM platform,
see the ....
Regards,
Fan
^ permalink raw reply [flat|nested] 22+ messages in thread
* [dpdk-dev v6] doc: support IPsec Multi-buffer lib v1.3
2022-11-15 17:11 ` [dpdk-dev v5] " Kai Ji
2022-11-15 20:17 ` Zhang, Fan
@ 2022-11-16 12:06 ` Kai Ji
2022-11-17 12:16 ` Kai Ji
1 sibling, 1 reply; 22+ messages in thread
From: Kai Ji @ 2022-11-16 12:06 UTC (permalink / raw)
To: dev; +Cc: gakhil, Pablo de Lara, Kai Ji
From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G
and CHACHA20_POLY1305 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>
Acked-by: Brian Dooley <brian.dooley@intel.com>
Signed-off-by: Kai Ji <kai.ji@intel.com>
---
-v6: Release notes update reword
-v5: Release notes update
-v4: Added information on CHACHA20_POLY1305 PMD guide
-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 | 29 ++++++++++++++++-----
doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++++++---
doc/guides/cryptodevs/kasumi.rst | 15 ++++++++---
doc/guides/cryptodevs/snow3g.rst | 15 ++++++++---
doc/guides/cryptodevs/zuc.rst | 14 +++++++---
doc/guides/rel_notes/release_22_11.rst | 11 +++++++-
7 files changed, 77 insertions(+), 27 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..b9bf03655d 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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,23 @@ 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.
+
+AESNI MB PMD selection over CHACHA20-POLY1305 PMD
+-------------------------------------------------
+
+This PMD supports Chacha20-Poly1305 algorithm.
+On Intel processors, it is recommended to use this PMD instead of CHACHA20-POLY1305 PMD,
+as it delivers better performance on single segment buffers.
+For multi-segment buffers, it is still recommended to use CHACHA20-POLY1305 PMD,
+until the new SGL API is introduced in the AESNI MB PMD.
Installation
------------
@@ -84,8 +99,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 +145,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.
diff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst b/doc/guides/cryptodevs/chacha20_poly1305.rst
index 4db260818e..7d69c4b192 100644
--- a/doc/guides/cryptodevs/chacha20_poly1305.rst
+++ b/doc/guides/cryptodevs/chacha20_poly1305.rst
@@ -16,6 +16,12 @@ AEAD algorithms:
* RTE_CRYPTO_AEAD_CHACHA20_POLY1305
+Chaha20_Poly1305 PMD vs AESNI MB PMD
+------------------------------------
+
+AESNI MB PMD also supports CHACHA20-POLY1305 algorithms.
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors, when single-segment buffers are used.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
Installation
------------
@@ -23,8 +29,8 @@ Installation
To build DPDK with the Chacha20-poly1305 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.0, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.0.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:
@@ -64,7 +70,7 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 21.11+ Multi-buffer library 1.0*
+ 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.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..a27a6ea050 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..8b646dd1e0 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -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.
diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 4e55b543ef..3a0a75617e 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -240,7 +240,16 @@ New Features
* **Updated ipsec_mb crypto driver.**
- Added SNOW-3G and ZUC support for ARM platform.
+ * Added ARM64 port of ipsec-mb library support and SNOW-3G and ZUC
+ support for ARM platform.
+ * Added Intel IPsec MB v1.3 library support for x86 and ARM platform,
+ see the following guides for more details:
+ :doc:`../cryptodevs/aesni_gcm`
+ :doc:`../cryptodevs/aesni_mb`
+ :doc:`../cryptodevs/chacha20_poly1305`
+ :doc:`../cryptodevs/kasumi`
+ :doc:`../cryptodevs/snow3g`
+ :doc:`../cryptodevs/zuc`
* **Added UADK crypto driver.**
--
2.17.1
^ permalink raw reply [flat|nested] 22+ messages in thread* [dpdk-dev v6] doc: support IPsec Multi-buffer lib v1.3
2022-11-16 12:06 ` [dpdk-dev v6] " Kai Ji
@ 2022-11-17 12:16 ` Kai Ji
2022-11-21 6:57 ` [EXT] " Akhil Goyal
2022-11-21 16:35 ` [dpdk-dev v7] " Kai Ji
0 siblings, 2 replies; 22+ messages in thread
From: Kai Ji @ 2022-11-17 12:16 UTC (permalink / raw)
To: dev; +Cc: gakhil, Pablo de Lara, Kai Ji
From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G
and CHACHA20_POLY1305 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>
Acked-by: Brian Dooley <brian.dooley@intel.com>
Signed-off-by: Kai Ji <kai.ji@intel.com>
---
-v6: Release notes update reword
-v5: Release notes update
-v4: Added information on CHACHA20_POLY1305 PMD guide
-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 | 29 ++++++++++++++++-----
doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++++++---
doc/guides/cryptodevs/kasumi.rst | 15 ++++++++---
doc/guides/cryptodevs/snow3g.rst | 15 ++++++++---
doc/guides/cryptodevs/zuc.rst | 14 +++++++---
doc/guides/rel_notes/release_22_11.rst | 11 +++++++-
7 files changed, 77 insertions(+), 27 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..b9bf03655d 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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,23 @@ 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.
+
+AESNI MB PMD selection over CHACHA20-POLY1305 PMD
+-------------------------------------------------
+
+This PMD supports Chacha20-Poly1305 algorithm.
+On Intel processors, it is recommended to use this PMD instead of CHACHA20-POLY1305 PMD,
+as it delivers better performance on single segment buffers.
+For multi-segment buffers, it is still recommended to use CHACHA20-POLY1305 PMD,
+until the new SGL API is introduced in the AESNI MB PMD.
Installation
------------
@@ -84,8 +99,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 +145,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.
diff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst b/doc/guides/cryptodevs/chacha20_poly1305.rst
index 4db260818e..7d69c4b192 100644
--- a/doc/guides/cryptodevs/chacha20_poly1305.rst
+++ b/doc/guides/cryptodevs/chacha20_poly1305.rst
@@ -16,6 +16,12 @@ AEAD algorithms:
* RTE_CRYPTO_AEAD_CHACHA20_POLY1305
+Chaha20_Poly1305 PMD vs AESNI MB PMD
+------------------------------------
+
+AESNI MB PMD also supports CHACHA20-POLY1305 algorithms.
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors, when single-segment buffers are used.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
Installation
------------
@@ -23,8 +29,8 @@ Installation
To build DPDK with the Chacha20-poly1305 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.0, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.0.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:
@@ -64,7 +70,7 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 21.11+ Multi-buffer library 1.0*
+ 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.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..a27a6ea050 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..8b646dd1e0 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -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.
diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 4e55b543ef..b98b603fe7 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -240,7 +240,16 @@ New Features
* **Updated ipsec_mb crypto driver.**
- Added SNOW-3G and ZUC support for ARM platform.
+ * Added ARM64 port of ipsec-mb library support and SNOW-3G and ZUC
+ support for ARM platform.
+ * Added Intel IPsec MB v1.3 library support for x86 platform,
+ see the following guides for more details:
+ :doc:`../cryptodevs/aesni_gcm`
+ :doc:`../cryptodevs/aesni_mb`
+ :doc:`../cryptodevs/chacha20_poly1305`
+ :doc:`../cryptodevs/kasumi`
+ :doc:`../cryptodevs/snow3g`
+ :doc:`../cryptodevs/zuc`
* **Added UADK crypto driver.**
--
2.17.1
^ permalink raw reply [flat|nested] 22+ messages in thread* RE: [EXT] [dpdk-dev v6] doc: support IPsec Multi-buffer lib v1.3
2022-11-17 12:16 ` Kai Ji
@ 2022-11-21 6:57 ` Akhil Goyal
2022-11-21 10:57 ` Zhang, Fan
2022-11-21 16:35 ` [dpdk-dev v7] " Kai Ji
1 sibling, 1 reply; 22+ messages in thread
From: Akhil Goyal @ 2022-11-21 6:57 UTC (permalink / raw)
To: Kai Ji, dev; +Cc: Pablo de Lara
> diff --git a/doc/guides/rel_notes/release_22_11.rst
> b/doc/guides/rel_notes/release_22_11.rst
> index 4e55b543ef..b98b603fe7 100644
> --- a/doc/guides/rel_notes/release_22_11.rst
> +++ b/doc/guides/rel_notes/release_22_11.rst
> @@ -240,7 +240,16 @@ New Features
>
> * **Updated ipsec_mb crypto driver.**
>
> - Added SNOW-3G and ZUC support for ARM platform.
> + * Added ARM64 port of ipsec-mb library support and SNOW-3G and ZUC
> + support for ARM platform.
You need not update the above line.
* Added SNOW-3G and ZUC support for ARM platform.
Should be good enough.
> + * Added Intel IPsec MB v1.3 library support for x86 platform,
> + see the following guides for more details:
> + :doc:`../cryptodevs/aesni_gcm`
> + :doc:`../cryptodevs/aesni_mb`
> + :doc:`../cryptodevs/chacha20_poly1305`
> + :doc:`../cryptodevs/kasumi`
> + :doc:`../cryptodevs/snow3g`
> + :doc:`../cryptodevs/zuc`
I believe adding reference for each guide is not needed.
* Added Intel IPsec MB v1.3 library support for x86 platform.
Added details in the guides for all the drivers supported by ipsec_mb.
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [EXT] [dpdk-dev v6] doc: support IPsec Multi-buffer lib v1.3
2022-11-21 6:57 ` [EXT] " Akhil Goyal
@ 2022-11-21 10:57 ` Zhang, Fan
2022-11-21 11:35 ` Akhil Goyal
0 siblings, 1 reply; 22+ messages in thread
From: Zhang, Fan @ 2022-11-21 10:57 UTC (permalink / raw)
To: Akhil Goyal, Kai Ji, dev; +Cc: Pablo de Lara
Hi Akhil,
From 22.11 the ipsec-mb PMDs will be working on two different libraries
that may or may not work the same.
We also have two different contributor groups working on adding features
on top of each library, again one may or may not be compatible to another.
I believe there should be some words necessary to distinguish each
library support as well as the credits for adding certain features for
one platform.
On 11/21/2022 6:57 AM, Akhil Goyal wrote:
>> diff --git a/doc/guides/rel_notes/release_22_11.rst
>> b/doc/guides/rel_notes/release_22_11.rst
>> index 4e55b543ef..b98b603fe7 100644
>> --- a/doc/guides/rel_notes/release_22_11.rst
>> +++ b/doc/guides/rel_notes/release_22_11.rst
>> @@ -240,7 +240,16 @@ New Features
>>
>> * **Updated ipsec_mb crypto driver.**
>>
>> - Added SNOW-3G and ZUC support for ARM platform.
>> + * Added ARM64 port of ipsec-mb library support and SNOW-3G and ZUC
>> + support for ARM platform.
> You need not update the above line.
> * Added SNOW-3G and ZUC support for ARM platform.
> Should be good enough.
>> + * Added Intel IPsec MB v1.3 library support for x86 platform,
>> + see the following guides for more details:
>> + :doc:`../cryptodevs/aesni_gcm`
>> + :doc:`../cryptodevs/aesni_mb`
>> + :doc:`../cryptodevs/chacha20_poly1305`
>> + :doc:`../cryptodevs/kasumi`
>> + :doc:`../cryptodevs/snow3g`
>> + :doc:`../cryptodevs/zuc`
> I believe adding reference for each guide is not needed.
>
> * Added Intel IPsec MB v1.3 library support for x86 platform.
> Added details in the guides for all the drivers supported by ipsec_mb.
What the guideline Pablo/Kai added here only applies for x86 as
a. ARM does not support algorithms other than SNOW3G and ZUC.
b. The performance guideline may not apply to ARM.
Regards,
Fan
^ permalink raw reply [flat|nested] 22+ messages in thread
* RE: [EXT] [dpdk-dev v6] doc: support IPsec Multi-buffer lib v1.3
2022-11-21 10:57 ` Zhang, Fan
@ 2022-11-21 11:35 ` Akhil Goyal
2022-11-21 13:52 ` Zhang, Fan
0 siblings, 1 reply; 22+ messages in thread
From: Akhil Goyal @ 2022-11-21 11:35 UTC (permalink / raw)
To: Zhang, Fan, Kai Ji, dev; +Cc: Pablo de Lara
Hi Fan,
> Hi Akhil,
>
>
> From 22.11 the ipsec-mb PMDs will be working on two different libraries
> that may or may not work the same.
>
> We also have two different contributor groups working on adding features
> on top of each library, again one may or may not be compatible to another.
>
> I believe there should be some words necessary to distinguish each
> library support as well as the credits for adding certain features for
> one platform.
Ok, but release notes is not a correct place to mention that.
It should be part of the respective driver documentation.
>
>
> On 11/21/2022 6:57 AM, Akhil Goyal wrote:
> >> diff --git a/doc/guides/rel_notes/release_22_11.rst
> >> b/doc/guides/rel_notes/release_22_11.rst
> >> index 4e55b543ef..b98b603fe7 100644
> >> --- a/doc/guides/rel_notes/release_22_11.rst
> >> +++ b/doc/guides/rel_notes/release_22_11.rst
> >> @@ -240,7 +240,16 @@ New Features
> >>
> >> * **Updated ipsec_mb crypto driver.**
> >>
> >> - Added SNOW-3G and ZUC support for ARM platform.
> >> + * Added ARM64 port of ipsec-mb library support and SNOW-3G and ZUC
> >> + support for ARM platform.
> > You need not update the above line.
> > * Added SNOW-3G and ZUC support for ARM platform.
> > Should be good enough.
> >> + * Added Intel IPsec MB v1.3 library support for x86 platform,
> >> + see the following guides for more details:
> >> + :doc:`../cryptodevs/aesni_gcm`
> >> + :doc:`../cryptodevs/aesni_mb`
> >> + :doc:`../cryptodevs/chacha20_poly1305`
> >> + :doc:`../cryptodevs/kasumi`
> >> + :doc:`../cryptodevs/snow3g`
> >> + :doc:`../cryptodevs/zuc`
> > I believe adding reference for each guide is not needed.
> >
> > * Added Intel IPsec MB v1.3 library support for x86 platform.
> > Added details in the guides for all the drivers supported by ipsec_mb.
>
> What the guideline Pablo/Kai added here only applies for x86 as
>
> a. ARM does not support algorithms other than SNOW3G and ZUC.
This should be distinguished in the .rst file.
For release notes, above thing is sufficient.
>
> b. The performance guideline may not apply to ARM.
Again, it should be part of driver documentation and not release notes.
And for each of the release note bullet that I suggested are mentioning the
Platform on which the support is added.
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [EXT] [dpdk-dev v6] doc: support IPsec Multi-buffer lib v1.3
2022-11-21 11:35 ` Akhil Goyal
@ 2022-11-21 13:52 ` Zhang, Fan
0 siblings, 0 replies; 22+ messages in thread
From: Zhang, Fan @ 2022-11-21 13:52 UTC (permalink / raw)
To: Akhil Goyal, Kai Ji, dev; +Cc: Pablo de Lara
Hi Akhil,
Agreed. Thanks for clarification.
Regards,
Fan
On 11/21/2022 11:35 AM, Akhil Goyal wrote:
> Hi Fan,
>> Hi Akhil,
>>
>>
>> From 22.11 the ipsec-mb PMDs will be working on two different libraries
>> that may or may not work the same.
>>
>> We also have two different contributor groups working on adding features
>> on top of each library, again one may or may not be compatible to another.
>>
>> I believe there should be some words necessary to distinguish each
>> library support as well as the credits for adding certain features for
>> one platform.
> Ok, but release notes is not a correct place to mention that.
> It should be part of the respective driver documentation.
>
>>
>> On 11/21/2022 6:57 AM, Akhil Goyal wrote:
>>>> diff --git a/doc/guides/rel_notes/release_22_11.rst
>>>> b/doc/guides/rel_notes/release_22_11.rst
>>>> index 4e55b543ef..b98b603fe7 100644
>>>> --- a/doc/guides/rel_notes/release_22_11.rst
>>>> +++ b/doc/guides/rel_notes/release_22_11.rst
>>>> @@ -240,7 +240,16 @@ New Features
>>>>
>>>> * **Updated ipsec_mb crypto driver.**
>>>>
>>>> - Added SNOW-3G and ZUC support for ARM platform.
>>>> + * Added ARM64 port of ipsec-mb library support and SNOW-3G and ZUC
>>>> + support for ARM platform.
>>> You need not update the above line.
>>> * Added SNOW-3G and ZUC support for ARM platform.
>>> Should be good enough.
>>>> + * Added Intel IPsec MB v1.3 library support for x86 platform,
>>>> + see the following guides for more details:
>>>> + :doc:`../cryptodevs/aesni_gcm`
>>>> + :doc:`../cryptodevs/aesni_mb`
>>>> + :doc:`../cryptodevs/chacha20_poly1305`
>>>> + :doc:`../cryptodevs/kasumi`
>>>> + :doc:`../cryptodevs/snow3g`
>>>> + :doc:`../cryptodevs/zuc`
>>> I believe adding reference for each guide is not needed.
>>>
>>> * Added Intel IPsec MB v1.3 library support for x86 platform.
>>> Added details in the guides for all the drivers supported by ipsec_mb.
>> What the guideline Pablo/Kai added here only applies for x86 as
>>
>> a. ARM does not support algorithms other than SNOW3G and ZUC.
> This should be distinguished in the .rst file.
> For release notes, above thing is sufficient.
>
>> b. The performance guideline may not apply to ARM.
> Again, it should be part of driver documentation and not release notes.
>
> And for each of the release note bullet that I suggested are mentioning the
> Platform on which the support is added.
>
>
^ permalink raw reply [flat|nested] 22+ messages in thread
* [dpdk-dev v7] doc: support IPsec Multi-buffer lib v1.3
2022-11-17 12:16 ` Kai Ji
2022-11-21 6:57 ` [EXT] " Akhil Goyal
@ 2022-11-21 16:35 ` Kai Ji
2022-11-22 11:57 ` Thomas Monjalon
1 sibling, 1 reply; 22+ messages in thread
From: Kai Ji @ 2022-11-21 16:35 UTC (permalink / raw)
To: dev; +Cc: gakhil, Pablo de Lara, Kai Ji
From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G
and CHACHA20_POLY1305 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>
Acked-by: Brian Dooley <brian.dooley@intel.com>
Signed-off-by: Kai Ji <kai.ji@intel.com>
---
-v7: Review comments update
-v6: Release notes update reword
-v5: Release notes update
-v4: Added information on CHACHA20_POLY1305 PMD guide
-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 | 29 ++++++++++++++++-----
doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++++++---
doc/guides/cryptodevs/kasumi.rst | 15 ++++++++---
doc/guides/cryptodevs/snow3g.rst | 19 +++++++++++---
doc/guides/cryptodevs/zuc.rst | 18 ++++++++++---
doc/guides/rel_notes/release_22_11.rst | 3 ++-
7 files changed, 77 insertions(+), 27 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..b9bf03655d 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -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,23 @@ 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.
+
+AESNI MB PMD selection over CHACHA20-POLY1305 PMD
+-------------------------------------------------
+
+This PMD supports Chacha20-Poly1305 algorithm.
+On Intel processors, it is recommended to use this PMD instead of CHACHA20-POLY1305 PMD,
+as it delivers better performance on single segment buffers.
+For multi-segment buffers, it is still recommended to use CHACHA20-POLY1305 PMD,
+until the new SGL API is introduced in the AESNI MB PMD.
Installation
------------
@@ -84,8 +99,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 +145,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.
diff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst b/doc/guides/cryptodevs/chacha20_poly1305.rst
index 4db260818e..7d69c4b192 100644
--- a/doc/guides/cryptodevs/chacha20_poly1305.rst
+++ b/doc/guides/cryptodevs/chacha20_poly1305.rst
@@ -16,6 +16,12 @@ AEAD algorithms:
* RTE_CRYPTO_AEAD_CHACHA20_POLY1305
+Chaha20_Poly1305 PMD vs AESNI MB PMD
+------------------------------------
+
+AESNI MB PMD also supports CHACHA20-POLY1305 algorithms.
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors, when single-segment buffers are used.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
Installation
------------
@@ -23,8 +29,8 @@ Installation
To build DPDK with the Chacha20-poly1305 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.0, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.0.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:
@@ -64,7 +70,7 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 21.11+ Multi-buffer library 1.0*
+ 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.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -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.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..d943fe77b8 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -21,6 +21,10 @@ Authentication algorithm:
* RTE_CRYPTO_AUTH_SNOW3G_UIA2
+.. note::
+
+ The latest v1.3 add ARM64 port of ipsec-mb library support ARM platform.
+
Limitations
-----------
@@ -29,6 +33,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 +48,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 +94,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.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..c3459c234e 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -21,6 +21,10 @@ Authentication algorithm:
* RTE_CRYPTO_AUTH_ZUC_EIA3
+.. note::
+
+ The latest v1.3 add ARM64 port of ipsec-mb library support ARM platform.
+
Limitations
-----------
@@ -28,6 +32,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 +47,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 +93,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.
diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 5e091403ad..16d9d33439 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -240,7 +240,8 @@ New Features
* **Updated ipsec_mb crypto driver.**
- Added SNOW-3G and ZUC support for ARM platform.
+ * Added SNOW-3G and ZUC support for ARM platform.
+ * Added Intel IPsec MB v1.3 library support for x86 platform.
* **Added UADK crypto driver.**
--
2.17.1
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [dpdk-dev v7] doc: support IPsec Multi-buffer lib v1.3
2022-11-21 16:35 ` [dpdk-dev v7] " Kai Ji
@ 2022-11-22 11:57 ` Thomas Monjalon
0 siblings, 0 replies; 22+ messages in thread
From: Thomas Monjalon @ 2022-11-22 11:57 UTC (permalink / raw)
To: Kai Ji; +Cc: dev, gakhil, Pablo de Lara
21/11/2022 17:35, Kai Ji:
> From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
>
> Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G
> and CHACHA20_POLY1305 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>
> Acked-by: Brian Dooley <brian.dooley@intel.com>
> Signed-off-by: Kai Ji <kai.ji@intel.com>
Applied with few formatting improvements.
^ permalink raw reply [flat|nested] 22+ messages in thread
end of thread, other threads:[~2022-11-22 11:57 UTC | newest]
Thread overview: 22+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-09 18:33 [PATCH] doc: support IPsec Multi-buffer lib v1.3 Pablo de Lara
2022-11-09 18:39 ` [PATCH v2] " Pablo de Lara
2022-11-10 9:38 ` [EXT] " Akhil Goyal
2022-11-10 10:43 ` Power, Ciara
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
2022-11-10 11:17 ` Dooley, Brian
2022-11-10 11:39 ` Ji, Kai
2022-11-11 16:24 ` De Lara Guarch, Pablo
2022-11-10 16:44 ` Zhang, Fan
2022-11-12 11:26 ` [PATCH v4] " Pablo de Lara
2022-11-14 23:34 ` Ji, Kai
2022-11-15 9:24 ` Akhil Goyal
2022-11-15 17:11 ` [dpdk-dev v5] " Kai Ji
2022-11-15 20:17 ` Zhang, Fan
2022-11-16 12:06 ` [dpdk-dev v6] " Kai Ji
2022-11-17 12:16 ` Kai Ji
2022-11-21 6:57 ` [EXT] " Akhil Goyal
2022-11-21 10:57 ` Zhang, Fan
2022-11-21 11:35 ` Akhil Goyal
2022-11-21 13:52 ` Zhang, Fan
2022-11-21 16:35 ` [dpdk-dev v7] " Kai Ji
2022-11-22 11:57 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).