From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
To: kai.ji@intel.com
Cc: dev@dpdk.org, Pablo de Lara <pablo.de.lara.guarch@intel.com>
Subject: [PATCH v2] doc: support IPsec Multi-buffer lib v1.3
Date: Wed, 9 Nov 2022 18:39:13 +0000 [thread overview]
Message-ID: <20221109183913.3910691-1-pablo.de.lara.guarch@intel.com> (raw)
In-Reply-To: <20221109183317.3909285-1-pablo.de.lara.guarch@intel.com>
Updated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G PMD documentation
guides with information about the latest Intel IPSec Multi-buffer
library supported.
Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
- v2: Removed repeated word 'the'
---
doc/guides/cryptodevs/aesni_gcm.rst | 8 ++++----
doc/guides/cryptodevs/aesni_mb.rst | 18 ++++++++++++------
doc/guides/cryptodevs/kasumi.rst | 15 +++++++++++----
doc/guides/cryptodevs/snow3g.rst | 15 +++++++++++----
doc/guides/cryptodevs/zuc.rst | 14 ++++++++++----
5 files changed, 48 insertions(+), 22 deletions(-)
diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 6229392f58..5192287ed8 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -40,8 +40,8 @@ Installation
To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer
library from `here <https://github.com/01org/intel-ipsec-mb>`_
and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
.. code-block:: console
@@ -84,8 +84,8 @@ and the external crypto libraries supported by them:
17.08 - 18.02 Multi-buffer library 0.46 - 0.48
18.05 - 19.02 Multi-buffer library 0.49 - 0.52
19.05 - 20.08 Multi-buffer library 0.52 - 0.55
- 20.11 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.11 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 599ed5698f..3d0cd3de85 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2015-2018 Intel Corporation.
-AESN-NI Multi Buffer Crypto Poll Mode Driver
+AES-NI Multi Buffer Crypto Poll Mode Driver
============================================
@@ -10,8 +10,6 @@ support for utilizing Intel multi buffer library, see the white paper
`Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors
<https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_.
-The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc.
-
The AES-NI MB PMD supports synchronous mode of operation with
``rte_cryptodev_sym_cpu_crypto_process`` function call.
@@ -77,6 +75,14 @@ Limitations
* RTE_CRYPTO_CIPHER_DES_DOCSISBPI is not supported for combined Crypto-CRC
DOCSIS security protocol.
+AESNI MB PMD selection over SNOW3G/ZUC/KASUMI PMDs
+--------------------------------------------------
+
+This PMD supports wireless cipher suite (SNOW3G, ZUC and KASUMI).
+On Intel processors, it is recommended to use this PMD instead of SNOW3G, ZUC and KASUMI PMDs,
+as it enables algorithm mixing (e.g. cipher algorithm SNOW3G-UEA2 with
+authentication algorithm AES-CMAC-128) and performance over IMIX (packet size mix) traffic
+is significantly higher.
Installation
------------
@@ -84,8 +90,8 @@ Installation
To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer
library from `here <https://github.com/01org/intel-ipsec-mb>`_
and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
.. code-block:: console
@@ -131,7 +137,7 @@ and the Multi-Buffer library version supported by them:
19.05 - 19.08 0.52
19.11 - 20.08 0.52 - 0.55
20.11 - 21.08 0.53 - 1.2*
- 21.11+ 1.0 - 1.2*
+ 21.11+ 1.0 - 1.3*
============== ============================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
index d8128928f8..c8e8f1b847 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -30,14 +30,21 @@ Limitations
(if length and/or offset of data to be ciphered is not byte-aligned).
+KASUMI PMD vs AESNI MB PMD
+--------------------------
+
+AESNI MB PMD also supports KASUMI cipher and authentication algorithms,
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
+
Installation
------------
To build DPDK with the KASUMI_PMD the user is required to download the multi-buffer
library from `here <https://github.com/01org/intel-ipsec-mb>`_
and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
After downloading the library, the user needs to unpack and compile it
on their system before building DPDK:
@@ -78,8 +85,8 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.11 - 19.11 LibSSO KASUMI
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
index 02e857c0d2..a27a6ea050 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -29,6 +29,13 @@ Limitations
* In-place bit-level operations for SNOW 3G (UEA2) are not supported
(if length and/or offset of data to be ciphered is not byte-aligned).
+SNOW3G PMD vs AESNI MB PMD
+--------------------------
+
+AESNI MB PMD also supports SNOW3G cipher and authentication algorithms,
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
+
Installation
------------
@@ -37,8 +44,8 @@ library and compile it on their user system before building DPDK.
For x86 system, the multi-buffer library is available
`here <https://github.com/01org/intel-ipsec-mb>`_.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
For Arm system, ARM64 port of the multi-buffer library can be downloaded from
`<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The
@@ -83,8 +90,8 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.04 - 19.11 LibSSO SNOW3G
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index 10d44b7393..8b646dd1e0 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -28,6 +28,12 @@ Limitations
* ZUC (EIA3) supported only if hash offset field is byte-aligned.
* ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned.
+ZUC PMD vs AESNI MB PMD
+-----------------------
+
+AESNI MB PMD also supports ZUC cipher and authentication algorithms,
+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.
+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.
Installation
------------
@@ -37,8 +43,8 @@ library and compile it on their user system before building DPDK.
For x86 system, the multi-buffer library is available
`here <https://github.com/01org/intel-ipsec-mb>`_.
-The latest version of the library supported by this PMD is v1.2, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.
+The latest version of the library supported by this PMD is v1.3, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.
For Arm system, ARM64 port of the multi-buffer library can be downloaded from
`<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The
@@ -83,8 +89,8 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.11 - 19.11 LibSSO ZUC
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*
- 21.11+ Multi-buffer library 1.0 - 1.2*
+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
+ 21.11+ Multi-buffer library 1.0 - 1.3*
============= ================================
\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
--
2.34.1
next prev parent reply other threads:[~2022-11-09 18:39 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-09 18:33 [PATCH] " Pablo de Lara
2022-11-09 18:39 ` Pablo de Lara [this message]
2022-11-10 9:38 ` [EXT] [PATCH v2] " Akhil Goyal
2022-11-10 10:43 ` Power, Ciara
2022-11-10 11:07 ` [PATCH v3] " Pablo de Lara
2022-11-10 11:17 ` Dooley, Brian
2022-11-10 11:39 ` Ji, Kai
2022-11-11 16:24 ` De Lara Guarch, Pablo
2022-11-10 16:44 ` Zhang, Fan
2022-11-12 11:26 ` [PATCH v4] " Pablo de Lara
2022-11-14 23:34 ` Ji, Kai
2022-11-15 9:24 ` Akhil Goyal
2022-11-15 17:11 ` [dpdk-dev v5] " Kai Ji
2022-11-15 20:17 ` Zhang, Fan
2022-11-16 12:06 ` [dpdk-dev v6] " Kai Ji
2022-11-17 12:16 ` Kai Ji
2022-11-21 6:57 ` [EXT] " Akhil Goyal
2022-11-21 10:57 ` Zhang, Fan
2022-11-21 11:35 ` Akhil Goyal
2022-11-21 13:52 ` Zhang, Fan
2022-11-21 16:35 ` [dpdk-dev v7] " Kai Ji
2022-11-22 11:57 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221109183913.3910691-1-pablo.de.lara.guarch@intel.com \
--to=pablo.de.lara.guarch@intel.com \
--cc=dev@dpdk.org \
--cc=kai.ji@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).