Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/120001/?format=api
{ "id": 120001, "url": "https://patches.dpdk.org/api/patches/120001/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20221121163517.3053-1-kai.ji@intel.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20221121163517.3053-1-kai.ji@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20221121163517.3053-1-kai.ji@intel.com", "date": "2022-11-21T16:35:17", "name": "[v7] doc: support IPsec Multi-buffer lib v1.3", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "07effaa6fde50808571de5abfc4512ae45854a94", "submitter": { "id": 2202, "url": "https://patches.dpdk.org/api/people/2202/?format=api", "name": "Ji, Kai", "email": "kai.ji@intel.com" }, "delegate": { "id": 6690, "url": "https://patches.dpdk.org/api/users/6690/?format=api", "username": "akhil", "first_name": "akhil", "last_name": "goyal", "email": "gakhil@marvell.com" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20221121163517.3053-1-kai.ji@intel.com/mbox/", "series": [ { "id": 25839, "url": "https://patches.dpdk.org/api/series/25839/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=25839", "date": "2022-11-21T16:35:17", "name": "[v7] doc: support IPsec Multi-buffer lib v1.3", "version": 7, "mbox": "https://patches.dpdk.org/series/25839/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/120001/comments/", "check": "fail", "checks": "https://patches.dpdk.org/api/patches/120001/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 34594A0566;\n\tMon, 21 Nov 2022 17:35:45 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id BFAA242D1D;\n\tMon, 21 Nov 2022 17:35:44 +0100 (CET)", "from mga07.intel.com (mga07.intel.com [134.134.136.100])\n by mails.dpdk.org (Postfix) with ESMTP id 7394342D15\n for <dev@dpdk.org>; Mon, 21 Nov 2022 17:35:42 +0100 (CET)", "from orsmga006.jf.intel.com ([10.7.209.51])\n by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 21 Nov 2022 08:35:20 -0800", "from silpixa00400465.ir.intel.com ([10.55.128.22])\n by orsmga006.jf.intel.com with ESMTP; 21 Nov 2022 08:35:19 -0800" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1669048542; x=1700584542;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=1W4Wrp6Mo//vXgguMdbGP3ns7JnGKPHd9kcKx1bCYd8=;\n b=kXbWXHiDMKUhxj2BUcy1sBwVSThevTmAu/uHDCxbsZK3nx6NpfZBjaUM\n +oozgq4tONEpKwkUQvJGUq+szuBOt7VjRf3WrWvKDcbUGJBqVaWiSCntj\n kE30isOhyQFIYx0LLyc2LeYWQg1fWO3b3jzQyO09hh10R5sudKopdlIMz\n fr4ho7vgs7tlJrBM90EDM9BjQiLG+jc26GXcNxL29j5taD1mujpsGg7gA\n L4lwqvfDbm5guUJOJ+29ivK030Leei473Utn1hhSwsXDsGlrEC5+8Gmdz\n 0WJy2wBXjDlj1HzPCS1rBoh28bz2017/sOW4TSjo+DMCDIWcU2GhleQwi A==;", "X-IronPort-AV": [ "E=McAfee;i=\"6500,9779,10538\"; a=\"377860432\"", "E=Sophos;i=\"5.96,181,1665471600\"; d=\"scan'208\";a=\"377860432\"", "E=McAfee;i=\"6500,9779,10538\"; a=\"618883752\"", "E=Sophos;i=\"5.96,181,1665471600\"; d=\"scan'208\";a=\"618883752\"" ], "X-ExtLoop1": "1", "From": "Kai Ji <kai.ji@intel.com>", "To": "dev@dpdk.org", "Cc": "gakhil@marvell.com, Pablo de Lara <pablo.de.lara.guarch@intel.com>,\n Kai Ji <kai.ji@intel.com>", "Subject": "[dpdk-dev v7] doc: support IPsec Multi-buffer lib v1.3", "Date": "Tue, 22 Nov 2022 00:35:17 +0800", "Message-Id": "<20221121163517.3053-1-kai.ji@intel.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20221117121618.50924-1-kai.ji@intel.com>", "References": "<20221117121618.50924-1-kai.ji@intel.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "From: Pablo de Lara <pablo.de.lara.guarch@intel.com>\n\nUpdated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G\nand CHACHA20_POLY1305 PMD documentation guides\nwith information about the latest Intel IPSec Multi-buffer\nlibrary supported.\n\nSigned-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>\nAcked-by: Ciara Power <ciara.power@intel.com>\nAcked-by: Brian Dooley <brian.dooley@intel.com>\nSigned-off-by: Kai Ji <kai.ji@intel.com>\n---\n-v7: Review comments update\n-v6: Release notes update reword\n-v5: Release notes update\n-v4: Added information on CHACHA20_POLY1305 PMD guide\n-v3: Fixed library version from 1.2 to 1.3 in one line\n-v2: Removed repeated word 'the'\n---\n doc/guides/cryptodevs/aesni_gcm.rst | 8 +++---\n doc/guides/cryptodevs/aesni_mb.rst | 29 ++++++++++++++++-----\n doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++++++---\n doc/guides/cryptodevs/kasumi.rst | 15 ++++++++---\n doc/guides/cryptodevs/snow3g.rst | 19 +++++++++++---\n doc/guides/cryptodevs/zuc.rst | 18 ++++++++++---\n doc/guides/rel_notes/release_22_11.rst | 3 ++-\n 7 files changed, 77 insertions(+), 27 deletions(-)\n\n--\n2.17.1", "diff": "diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst\nindex 6229392f58..5192287ed8 100644\n--- a/doc/guides/cryptodevs/aesni_gcm.rst\n+++ b/doc/guides/cryptodevs/aesni_gcm.rst\n@@ -40,8 +40,8 @@ Installation\n To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer\n library from `here <https://github.com/01org/intel-ipsec-mb>`_\n and compile it on their user system before building DPDK.\n-The latest version of the library supported by this PMD is v1.2, which\n-can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.\n+The latest version of the library supported by this PMD is v1.3, which\n+can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.\n\n .. code-block:: console\n\n@@ -84,8 +84,8 @@ and the external crypto libraries supported by them:\n 17.08 - 18.02 Multi-buffer library 0.46 - 0.48\n 18.05 - 19.02 Multi-buffer library 0.49 - 0.52\n 19.05 - 20.08 Multi-buffer library 0.52 - 0.55\n- 20.11 - 21.08 Multi-buffer library 0.53 - 1.2*\n- 21.11+ Multi-buffer library 1.0 - 1.2*\n+ 20.11 - 21.08 Multi-buffer library 0.53 - 1.3*\n+ 21.11+ Multi-buffer library 1.0 - 1.3*\n ============= ================================\n\n \\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.\ndiff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst\nindex 599ed5698f..b9bf03655d 100644\n--- a/doc/guides/cryptodevs/aesni_mb.rst\n+++ b/doc/guides/cryptodevs/aesni_mb.rst\n@@ -1,7 +1,7 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2015-2018 Intel Corporation.\n\n-AESN-NI Multi Buffer Crypto Poll Mode Driver\n+AES-NI Multi Buffer Crypto Poll Mode Driver\n ============================================\n\n\n@@ -10,8 +10,6 @@ support for utilizing Intel multi buffer library, see the white paper\n `Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors\n <https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_.\n\n-The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc.\n-\n The AES-NI MB PMD supports synchronous mode of operation with\n ``rte_cryptodev_sym_cpu_crypto_process`` function call.\n\n@@ -77,6 +75,23 @@ Limitations\n * RTE_CRYPTO_CIPHER_DES_DOCSISBPI is not supported for combined Crypto-CRC\n DOCSIS security protocol.\n\n+AESNI MB PMD selection over SNOW3G/ZUC/KASUMI PMDs\n+--------------------------------------------------\n+\n+This PMD supports wireless cipher suite (SNOW3G, ZUC and KASUMI).\n+On Intel processors, it is recommended to use this PMD instead of SNOW3G, ZUC and KASUMI PMDs,\n+as it enables algorithm mixing (e.g. cipher algorithm SNOW3G-UEA2 with\n+authentication algorithm AES-CMAC-128) and performance over IMIX (packet size mix) traffic\n+is significantly higher.\n+\n+AESNI MB PMD selection over CHACHA20-POLY1305 PMD\n+-------------------------------------------------\n+\n+This PMD supports Chacha20-Poly1305 algorithm.\n+On Intel processors, it is recommended to use this PMD instead of CHACHA20-POLY1305 PMD,\n+as it delivers better performance on single segment buffers.\n+For multi-segment buffers, it is still recommended to use CHACHA20-POLY1305 PMD,\n+until the new SGL API is introduced in the AESNI MB PMD.\n\n Installation\n ------------\n@@ -84,8 +99,8 @@ Installation\n To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer\n library from `here <https://github.com/01org/intel-ipsec-mb>`_\n and compile it on their user system before building DPDK.\n-The latest version of the library supported by this PMD is v1.2, which\n-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.\n+The latest version of the library supported by this PMD is v1.3, which\n+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.\n\n .. code-block:: console\n\n@@ -130,8 +145,8 @@ and the Multi-Buffer library version supported by them:\n 18.05 - 19.02 0.49 - 0.52\n 19.05 - 19.08 0.52\n 19.11 - 20.08 0.52 - 0.55\n- 20.11 - 21.08 0.53 - 1.2*\n- 21.11+ 1.0 - 1.2*\n+ 20.11 - 21.08 0.53 - 1.3*\n+ 21.11+ 1.0 - 1.3*\n ============== ============================\n\n \\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.\ndiff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst b/doc/guides/cryptodevs/chacha20_poly1305.rst\nindex 4db260818e..7d69c4b192 100644\n--- a/doc/guides/cryptodevs/chacha20_poly1305.rst\n+++ b/doc/guides/cryptodevs/chacha20_poly1305.rst\n@@ -16,6 +16,12 @@ AEAD algorithms:\n\n * RTE_CRYPTO_AEAD_CHACHA20_POLY1305\n\n+Chaha20_Poly1305 PMD vs AESNI MB PMD\n+------------------------------------\n+\n+AESNI MB PMD also supports CHACHA20-POLY1305 algorithms.\n+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors, when single-segment buffers are used.\n+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.\n\n Installation\n ------------\n@@ -23,8 +29,8 @@ Installation\n To build DPDK with the Chacha20-poly1305 PMD the user is required to download\n the multi-buffer library from `here <https://github.com/01org/intel-ipsec-mb>`_\n and compile it on their user system before building DPDK.\n-The latest version of the library supported by this PMD is v1.0, which\n-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.0.zip>`_.\n+The latest version of the library supported by this PMD is v1.3, which\n+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.\n\n After downloading the library, the user needs to unpack and compile it\n on their system before building DPDK:\n@@ -64,7 +70,7 @@ and the external crypto libraries supported by them:\n ============= ================================\n DPDK version Crypto library version\n ============= ================================\n- 21.11+ Multi-buffer library 1.0*\n+ 21.11+ Multi-buffer library 1.0-1.3*\n ============= ================================\n\n \\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.\ndiff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst\nindex d8128928f8..c8e8f1b847 100644\n--- a/doc/guides/cryptodevs/kasumi.rst\n+++ b/doc/guides/cryptodevs/kasumi.rst\n@@ -30,14 +30,21 @@ Limitations\n (if length and/or offset of data to be ciphered is not byte-aligned).\n\n\n+KASUMI PMD vs AESNI MB PMD\n+--------------------------\n+\n+AESNI MB PMD also supports KASUMI cipher and authentication algorithms,\n+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.\n+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.\n+\n Installation\n ------------\n\n To build DPDK with the KASUMI_PMD the user is required to download the multi-buffer\n library from `here <https://github.com/01org/intel-ipsec-mb>`_\n and compile it on their user system before building DPDK.\n-The latest version of the library supported by this PMD is v1.2, which\n-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.\n+The latest version of the library supported by this PMD is v1.3, which\n+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.\n\n After downloading the library, the user needs to unpack and compile it\n on their system before building DPDK:\n@@ -78,8 +85,8 @@ and the external crypto libraries supported by them:\n DPDK version Crypto library version\n ============= ================================\n 16.11 - 19.11 LibSSO KASUMI\n- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*\n- 21.11+ Multi-buffer library 1.0 - 1.2*\n+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*\n+ 21.11+ Multi-buffer library 1.0 - 1.3*\n ============= ================================\n\n \\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.\ndiff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst\nindex 02e857c0d2..d943fe77b8 100644\n--- a/doc/guides/cryptodevs/snow3g.rst\n+++ b/doc/guides/cryptodevs/snow3g.rst\n@@ -21,6 +21,10 @@ Authentication algorithm:\n\n * RTE_CRYPTO_AUTH_SNOW3G_UIA2\n\n+.. note::\n+\n+ The latest v1.3 add ARM64 port of ipsec-mb library support ARM platform.\n+\n Limitations\n -----------\n\n@@ -29,6 +33,13 @@ Limitations\n * In-place bit-level operations for SNOW 3G (UEA2) are not supported\n (if length and/or offset of data to be ciphered is not byte-aligned).\n\n+SNOW3G PMD vs AESNI MB PMD\n+--------------------------\n+\n+AESNI MB PMD also supports SNOW3G cipher and authentication algorithms,\n+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.\n+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.\n+\n Installation\n ------------\n\n@@ -37,8 +48,8 @@ library and compile it on their user system before building DPDK.\n\n For x86 system, the multi-buffer library is available\n `here <https://github.com/01org/intel-ipsec-mb>`_.\n-The latest version of the library supported by this PMD is v1.2, which\n-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.\n+The latest version of the library supported by this PMD is v1.3, which\n+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.\n\n For Arm system, ARM64 port of the multi-buffer library can be downloaded from\n `<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The\n@@ -83,8 +94,8 @@ and the external crypto libraries supported by them:\n DPDK version Crypto library version\n ============= ================================\n 16.04 - 19.11 LibSSO SNOW3G\n- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*\n- 21.11+ Multi-buffer library 1.0 - 1.2*\n+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*\n+ 21.11+ Multi-buffer library 1.0 - 1.3*\n ============= ================================\n\n \\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.\ndiff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst\nindex 10d44b7393..c3459c234e 100644\n--- a/doc/guides/cryptodevs/zuc.rst\n+++ b/doc/guides/cryptodevs/zuc.rst\n@@ -21,6 +21,10 @@ Authentication algorithm:\n\n * RTE_CRYPTO_AUTH_ZUC_EIA3\n\n+.. note::\n+\n+ The latest v1.3 add ARM64 port of ipsec-mb library support ARM platform.\n+\n Limitations\n -----------\n\n@@ -28,6 +32,12 @@ Limitations\n * ZUC (EIA3) supported only if hash offset field is byte-aligned.\n * ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned.\n\n+ZUC PMD vs AESNI MB PMD\n+-----------------------\n+\n+AESNI MB PMD also supports ZUC cipher and authentication algorithms,\n+It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors.\n+Take a look at the PMD documentation here :doc:`aesni_mb` for more information.\n\n Installation\n ------------\n@@ -37,8 +47,8 @@ library and compile it on their user system before building DPDK.\n\n For x86 system, the multi-buffer library is available\n `here <https://github.com/01org/intel-ipsec-mb>`_.\n-The latest version of the library supported by this PMD is v1.2, which\n-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_.\n+The latest version of the library supported by this PMD is v1.3, which\n+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_.\n\n For Arm system, ARM64 port of the multi-buffer library can be downloaded from\n `<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The\n@@ -83,8 +93,8 @@ and the external crypto libraries supported by them:\n DPDK version Crypto library version\n ============= ================================\n 16.11 - 19.11 LibSSO ZUC\n- 20.02 - 21.08 Multi-buffer library 0.53 - 1.2*\n- 21.11+ Multi-buffer library 1.0 - 1.2*\n+ 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*\n+ 21.11+ Multi-buffer library 1.0 - 1.3*\n ============= ================================\n\n \\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.\ndiff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst\nindex 5e091403ad..16d9d33439 100644\n--- a/doc/guides/rel_notes/release_22_11.rst\n+++ b/doc/guides/rel_notes/release_22_11.rst\n@@ -240,7 +240,8 @@ New Features\n\n * **Updated ipsec_mb crypto driver.**\n\n- Added SNOW-3G and ZUC support for ARM platform.\n+ * Added SNOW-3G and ZUC support for ARM platform.\n+ * Added Intel IPsec MB v1.3 library support for x86 platform.\n\n * **Added UADK crypto driver.**\n\n", "prefixes": [ "v7" ] }