doc: support IPsec Multi-buffer lib v1.3
PATCH 1/1 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.
--- 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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +12 -6
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +11 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +10 -4
@@ -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.
Signature · 1 line
2.34.1
PATCH v2 1/1 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.
---
- 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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +12 -6
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +11 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +10 -4
@@ -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.
Signature · 1 line
2.34.1
Quoted 8 lines
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 <[email protected]>---
Do you want to highlight in release notes as well?
Hi Pablo,
Quoted 24 lines
-----Original Message-----
From: Pablo de Lara <[email protected]>
Sent: Wednesday 9 November 2022 18:39
To: Ji, Kai <[email protected]>
Cc: [email protected]; De Lara Guarch, Pablo <[email protected]>
Subject: [PATCH v2] doc: support IPsec Multi-buffer lib v1.3Updated 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 <[email protected]>---
- 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>
Quoted 60 lines
doc/guides/cryptodevs/aesni_mb.rst +1
-1@@ -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 thewhite 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.doc/guides/cryptodevs/aesni_mb.rst +0
-0@@ -77,6 +75,14 @@ Limitations * RTE_CRYPTO_CIPHER_DES_DOCSISBPI is not supported for combinedCrypto-CRC
DOCSIS security protocol.doc/guides/cryptodevs/aesni_mb.rst +8
-0+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 issignificantly higher.
Installation
------------doc/guides/cryptodevs/aesni_mb.rst +0
-0@@ -84,8 +90,8 @@ Installation To build DPDK with the AESNI_MB_PMD the user is required to downloadthe 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>_.doc/guides/cryptodevs/aesni_mb.rst +2
-0+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
doc/guides/cryptodevs/aesni_mb.rst +0
-0@@ -131,7 +137,7 @@ and the Multi-Buffer library version supported bythem:
19.05 - 19.08 0.52 19.11 - 20.08 0.52 - 0.55 20.11 - 21.08 0.53 - 1.2*
doc/guides/cryptodevs/aesni_mb.rst and the Multi-Buffer library version supported by them: · line 141
Quoted 3 lines
doc/guides/cryptodevs/aesni_mb.rst +1
-1- 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.
PATCH v3 1/1 doc: support IPsec Multi-buffer lib v1.3
In reply to Pablo de LaraUpdated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G PMD documentation guides with information about the latest Intel IPSec Multi-buffer library supported.
---
-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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +13 -7
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +11 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +10 -4
@@ -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.
Signature · 1 line
2.34.1
Hi Pablo,
Quoted 20 lines
-----Original Message-----
From: Pablo de Lara <[email protected]>
Sent: Thursday, November 10, 2022 11:07 AM
To: Ji, Kai <[email protected]>
Cc: [email protected]; De Lara Guarch, Pablo <[email protected]>; Power, Ciara <[email protected]>
Subject: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3Updated 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 <[email protected]>Acked-by Ciara Power <[email protected]>---
(quoted diff) +0
-3-v3: Fixed library version from 1.2 to 1.3 in one line -v2: Removed repeated word 'the' ---
<snip>
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
Quoted 19 lines
-----Original Message-----
From: De Lara Guarch, Pablo <[email protected]>
Sent: Thursday, November 10, 2022 11:07 AM
To: Ji, Kai <[email protected]>
Cc: [email protected]; De Lara Guarch, Pablo <[email protected]>; Power, Ciara <[email protected]>
Subject: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3Updated 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 <[email protected]>Acked-by Ciara Power <[email protected]>---
(quoted diff) +0
-3-v3: Fixed library version from 1.2 to 1.3 in one line -v2: Removed repeated word 'the' ---
Hi Kai,
Quoted 10 lines
-----Original Message-----
From: Ji, Kai <[email protected]>
Sent: Thursday, November 10, 2022 11:40 AM
To: De Lara Guarch, Pablo <[email protected]>
Cc: [email protected]; Power, Ciara <[email protected]>
Subject: RE: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3Do 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
Quoted 24 lines
regards
Kai
Quoted 19 lines
-----Original Message-----
From: De Lara Guarch, Pablo <[email protected]>
Sent: Thursday, November 10, 2022 11:07 AM
To: Ji, Kai <[email protected]>
Cc: [email protected]; De Lara Guarch, Pablo <[email protected]>; Power, Ciara <[email protected]>
Subject: [PATCH v3] doc: support IPsec Multi-buffer lib v1.3Updated 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 <[email protected]>Acked-by Ciara Power <[email protected]>---
(quoted diff) +0
-3-v3: Fixed library version from 1.2 to 1.3 in one line -v2: Removed repeated word 'the' ---
Hi Pablo,
Review
Quoted 12 lines · 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 <[email protected]>Acked-by Ciara Power <[email protected]>---
(quoted diff) +0
-3-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
PATCH v4 1/1 doc: support IPsec Multi-buffer lib v1.3
In reply to Pablo de LaraUpdated 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.
---
-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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +22 -7
@@ -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.
doc/guides/cryptodevs/chacha20_poly1305.rst +9 -3
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +11 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +10 -4
@@ -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.
Signature · 1 line
2.37.3
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
Quoted 21 lines
-----Original Message-----
From: De Lara Guarch, Pablo <[email protected]>
Sent: Saturday, November 12, 2022 11:26 AM
To: Ji, Kai <[email protected]>
Cc: [email protected]; De Lara Guarch, Pablo <[email protected]>; Power, Ciara <[email protected]>; Dooley, Brian <[email protected]>
Subject: [PATCH v4] doc: support IPsec Multi-buffer lib v1.3Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
CHACHA20_POLY1305PMD documentation guides with information about the latest Intel IPSec Multi-buffer library supported.Signed-off-by Pablo de Lara <[email protected]>Acked-by Ciara Power <[email protected]>Acked-by Brian Dooley <[email protected]>---
(quoted diff) +0
-4-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' ---
Quoted 7 lines
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 therelease_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
PATCH v5 1/1 doc: support IPsec Multi-buffer lib v1.3
In reply to Pablo de LaraFrom: Pablo de Lara <[email protected]>
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.
---
-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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +22 -7
@@ -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.
doc/guides/cryptodevs/chacha20_poly1305.rst +9 -3
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +11 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +10 -4
@@ -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.
doc/guides/rel_notes/release_22_11.rst +9 -1
@@ -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
Hi,
Quoted 25 lines · Kai Ji
From: Pablo de Lara <[email protected]>
Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
CHACHA20_POLY1305PMD documentation guides with information about the latest Intel IPSec Multi-buffer library supported.Signed-off-by Pablo de Lara <[email protected]>Acked-by Ciara Power <[email protected]>Acked-by Brian Dooley <[email protected]>Signed-off-by Kai Ji <[email protected]>---
(quoted diff) +0
-5-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>
Quoted 22 lines
doc/guides/rel_notes/release_22_11.rst +9
-2@@ -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.** --
Quoted 1 line
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
PATCH v6 1/1 doc: support IPsec Multi-buffer lib v1.3
In reply to Kai JiFrom: Pablo de Lara <[email protected]>
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.
---
-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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +22 -7
@@ -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.
doc/guides/cryptodevs/chacha20_poly1305.rst +9 -3
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +11 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +10 -4
@@ -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.
doc/guides/rel_notes/release_22_11.rst +10 -1
@@ -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
PATCH v6 1/1 doc: support IPsec Multi-buffer lib v1.3
From: Pablo de Lara <[email protected]>
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.
---
-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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +22 -7
@@ -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.
doc/guides/cryptodevs/chacha20_poly1305.rst +9 -3
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +11 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +10 -4
@@ -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.
doc/guides/rel_notes/release_22_11.rst +10 -1
@@ -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
doc/guides/rel_notes/release_22_11.rst New Features · line 244
Quoted 12 lines
doc/guides/rel_notes/release_22_11.rst +2
-1@@ -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.
doc/guides/rel_notes/release_22_11.rst New Features · line 252
Quoted 8 lines
doc/guides/rel_notes/release_22_11.rst +8
-0+ * 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.
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.
Quoted 23 lines · Akhil Goyal
doc/guides/rel_notes/release_22_11.rst New Features · line 244
Quoted 12 lines
doc/guides/rel_notes/release_22_11.rst +2
-1@@ -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.doc/guides/rel_notes/release_22_11.rst New Features · line 252
Quoted 8 lines
doc/guides/rel_notes/release_22_11.rst +8
-0+ * 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`
Quoted 4 lines
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
Hi Fan,
Quoted 6 lines
Hi Akhil,
From 22.11 the ipsec-mb PMDs will be working on two different libraries
that may or may not work the same.
Quoted 6 lines
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.
Quoted 26 lines · Akhil Goyal
Quoted 23 lines
doc/guides/rel_notes/release_22_11.rst New Features · line 244
Quoted 12 lines
doc/guides/rel_notes/release_22_11.rst +2
-1@@ -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.Quoted 8 lines
doc/guides/rel_notes/release_22_11.rst +8
-0+ * 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`
Quoted 8 lines
Quoted 4 lines
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.
Quoted 2 lines
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.
Hi Akhil,
Agreed. Thanks for clarification.
Regards,
Fan
Quoted 58 lines · Akhil Goyal
Hi Fan,
Quoted 6 lines
Hi Akhil,
From 22.11 the ipsec-mb PMDs will be working on two different libraries
that may or may not work the same.Quoted 6 lines
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.
Quoted 25 lines · Akhil Goyal
Quoted 23 lines
doc/guides/rel_notes/release_22_11.rst New Features · line 244
Quoted 12 lines
doc/guides/rel_notes/release_22_11.rst +2
-1@@ -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.Quoted 8 lines
doc/guides/rel_notes/release_22_11.rst +8
-0+ * 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`Quoted 7 lines
Quoted 4 lines
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.Quoted 1 line
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.
PATCH v7 1/1 doc: support IPsec Multi-buffer lib v1.3
In reply to Kai JiFrom: Pablo de Lara <[email protected]>
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.
---
-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(-)
doc/guides/cryptodevs/aesni_gcm.rst +4 -4
@@ -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.
doc/guides/cryptodevs/aesni_mb.rst +22 -7
@@ -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.
doc/guides/cryptodevs/chacha20_poly1305.rst +9 -3
@@ -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.
doc/guides/cryptodevs/kasumi.rst +11 -4
@@ -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.
doc/guides/cryptodevs/snow3g.rst +15 -4
@@ -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.
doc/guides/cryptodevs/zuc.rst +14 -4
@@ -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.
doc/guides/rel_notes/release_22_11.rst +2 -1
@@ -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
21/11/2022 17:35, Kai Ji:
Quoted 11 lines
From: Pablo de Lara <[email protected]>
Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
CHACHA20_POLY1305PMD documentation guides with information about the latest Intel IPSec Multi-buffer library supported.Signed-off-by Pablo de Lara <[email protected]>Acked-by Ciara Power <[email protected]>Acked-by Brian Dooley <[email protected]>Signed-off-by Kai Ji <[email protected]>
Applied with few formatting improvements.