Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/39153/?format=api
{ "id": 39153, "url": "https://patches.dpdk.org/api/patches/39153/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1524872313-196340-11-git-send-email-lee.daly@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": "<1524872313-196340-11-git-send-email-lee.daly@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1524872313-196340-11-git-send-email-lee.daly@intel.com", "date": "2018-04-27T23:38:33", "name": "[dpdk-dev,v4,10/10] doc: add compression driver and ISA-L PMD docs", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "1d4fc03beeebea8af5d304634db205a197003363", "submitter": { "id": 825, "url": "https://patches.dpdk.org/api/people/825/?format=api", "name": "Daly, Lee", "email": "lee.daly@intel.com" }, "delegate": { "id": 22, "url": "https://patches.dpdk.org/api/users/22/?format=api", "username": "pdelarag", "first_name": "Pablo", "last_name": "de Lara Guarch", "email": "pablo.de.lara.guarch@intel.com" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1524872313-196340-11-git-send-email-lee.daly@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/39153/comments/", "check": "fail", "checks": "https://patches.dpdk.org/api/patches/39153/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id A5C098DB5;\n\tSat, 28 Apr 2018 01:40:00 +0200 (CEST)", "from mga06.intel.com (mga06.intel.com [134.134.136.31])\n\tby dpdk.org (Postfix) with ESMTP id 065F57CE1\n\tfor <dev@dpdk.org>; Sat, 28 Apr 2018 01:39:36 +0200 (CEST)", "from fmsmga003.fm.intel.com ([10.253.24.29])\n\tby orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t27 Apr 2018 16:39:36 -0700", "from silpixa00399501.ir.intel.com ([10.237.223.69])\n\tby FMSMGA003.fm.intel.com with ESMTP; 27 Apr 2018 16:39:35 -0700" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.49,336,1520924400\"; d=\"scan'208\";a=\"45186672\"", "From": "Lee Daly <lee.daly@intel.com>", "To": "dev@dpdk.org", "Cc": "pablo.de.lara.guarch@intel.com, greg.b.tucker@intel.com,\n\tdeepak.k.jain@intel.com, fiona.trahe@intel.com,\n\tLee Daly <lee.daly@intel.com>", "Date": "Sat, 28 Apr 2018 00:38:33 +0100", "Message-Id": "<1524872313-196340-11-git-send-email-lee.daly@intel.com>", "X-Mailer": "git-send-email 2.7.4", "In-Reply-To": "<1524872313-196340-1-git-send-email-lee.daly@intel.com>", "References": "<1523972132-6894-12-git-send-email-lee.daly@intel.com>\n\t<1524872313-196340-1-git-send-email-lee.daly@intel.com>", "Subject": "[dpdk-dev] [PATCH v4 10/10] doc: add compression driver and ISA-L\n\tPMD docs", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "This adds general compression drivers feature guide as well as the ISA-L PMD\ndocumentation and guide.\n\nSigned-off-by: Lee Daly <lee.daly@intel.com>\n---\n .gitignore | 1 +\n MAINTAINERS | 12 ++++\n devtools/test-build.sh | 4 ++\n doc/guides/compressdevs/features/default.ini | 24 +++++++\n doc/guides/compressdevs/features/isal.ini | 22 ++++++\n doc/guides/compressdevs/index.rst | 13 ++++\n doc/guides/compressdevs/isal.rst | 77 ++++++++++++++++++++\n doc/guides/compressdevs/overview.rst | 12 ++++\n doc/guides/compressdevs/overview_feature_table.txt | 84 ++++++++++++++++++++++\n doc/guides/conf.py | 5 ++\n doc/guides/index.rst | 1 +\n doc/guides/rel_notes/release_18_05.rst | 3 +-\n 12 files changed, 257 insertions(+), 1 deletion(-)\n create mode 100644 doc/guides/compressdevs/features/default.ini\n create mode 100644 doc/guides/compressdevs/features/isal.ini\n create mode 100644 doc/guides/compressdevs/index.rst\n create mode 100644 doc/guides/compressdevs/isal.rst\n create mode 100644 doc/guides/compressdevs/overview.rst\n create mode 100644 doc/guides/compressdevs/overview_feature_table.txt", "diff": "diff --git a/.gitignore b/.gitignore\nindex 6df5ba0..9105e26 100644\n--- a/.gitignore\n+++ b/.gitignore\n@@ -3,6 +3,7 @@ doc/guides/cryptodevs/overview_feature_table.txt\n doc/guides/cryptodevs/overview_cipher_table.txt\n doc/guides/cryptodevs/overview_auth_table.txt\n doc/guides/cryptodevs/overview_aead_table.txt\n+doc/guides/compressdevs/overview_feature_table.txt\n cscope.out.po\n cscope.out.in\n cscope.out\ndiff --git a/MAINTAINERS b/MAINTAINERS\nindex d2dd61c..a22f37f 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -766,6 +766,18 @@ F: doc/guides/cryptodevs/zuc.rst\n F: doc/guides/cryptodevs/features/zuc.ini\n \n \n+Compression Drivers\n+-------------------\n+M: Pablo de Lara <pablo.de.lara.guarch@intel.com>\n+T: git://dpdk.org/next/dpdk-next-crypto\n+F: doc/guides/compressdevs/features/default.ini\n+\n+ISA-L PMD\n+M: Lee Daly <lee.daly@intel.com>\n+F: drivers/compress/isal\n+F: doc/guides/compressdevs/isal.rst\n+F: doc/guides/compressdevs/features/isal.ini\n+\n Eventdev Drivers\n ----------------\n M: Jerin Jacob <jerin.jacob@caviumnetworks.com>\ndiff --git a/devtools/test-build.sh b/devtools/test-build.sh\nindex 3362edc..66f3ece 100755\n--- a/devtools/test-build.sh\n+++ b/devtools/test-build.sh\n@@ -45,6 +45,7 @@ default_path=$PATH\n # - DPDK_DEP_SSL (y/[n])\n # - DPDK_DEP_SZE (y/[n])\n # - DPDK_DEP_ZLIB (y/[n])\n+# - DPDK_DEP_ISAL (y/[n])\n # - DPDK_MAKE_JOBS (int)\n # - DPDK_NOTIFY (notify-send)\n # - FLEXRAN_SDK\n@@ -129,6 +130,7 @@ reset_env ()\n \tunset DPDK_DEP_SSL\n \tunset DPDK_DEP_SZE\n \tunset DPDK_DEP_ZLIB\n+\tunset DPDK_DEP_ISAL\n \tunset AESNI_MULTI_BUFFER_LIB_PATH\n \tunset ARMV8_CRYPTO_LIB_PATH\n \tunset FLEXRAN_SDK\n@@ -178,6 +180,8 @@ config () # <directory> <target> <options>\n \t\ttest \"$DPDK_DEP_ZLIB\" != y || \\\n \t\tsed -ri 's,(BNX2X_PMD=)n,\\1y,' $1/.config\n \t\tsed -ri 's,(NFP_PMD=)n,\\1y,' $1/.config\n+\t\ttest \"$DPDK_DEP_ISAL\" != y || \\\n+\t\tsed -ri 's,(ISAL_PMD=)n,\\1y,' $1/.config\n \t\ttest \"$DPDK_DEP_PCAP\" != y || \\\n \t\tsed -ri 's,(PCAP=)n,\\1y,' $1/.config\n \t\ttest -z \"$ARMV8_CRYPTO_LIB_PATH\" || \\\ndiff --git a/doc/guides/compressdevs/features/default.ini b/doc/guides/compressdevs/features/default.ini\nnew file mode 100644\nindex 0000000..795fc55\n--- /dev/null\n+++ b/doc/guides/compressdevs/features/default.ini\n@@ -0,0 +1,24 @@\n+;\n+; Features of a default compression driver.\n+;\n+; This file defines the features that are valid for inclusion in\n+; the other driver files and also the order that they appear in\n+; the features table in the documentation.\n+;\n+[Features]\n+HW Accelerated =\n+CPU SSE =\n+CPU AVX =\n+CPU AVX2 =\n+CPU AVX512 =\n+CPU NEON =\n+Stateful =\n+By-Pass =\n+Chained mbufs =\n+Deflate =\n+LZS =\n+Adler32 =\n+Crc32 =\n+Adler32&Crc32 =\n+Fixed =\n+Dynamic =\ndiff --git a/doc/guides/compressdevs/features/isal.ini b/doc/guides/compressdevs/features/isal.ini\nnew file mode 100644\nindex 0000000..6a6ffb8\n--- /dev/null\n+++ b/doc/guides/compressdevs/features/isal.ini\n@@ -0,0 +1,22 @@\n+;\n+; Refer to default.ini for the full list of available PMD features.\n+;\n+; Supported features of 'ISA-L' compression driver.\n+;\n+[Features]\n+HW Accelerated =\n+CPU SSE = Y\n+CPU AVX = Y\n+CPU AVX2 = Y\n+CPU AVX512 = Y\n+CPU NEON =\n+Stateful =\n+By-Pass =\n+Chained mbufs =\n+Deflate = Y\n+LZS =\n+Adler32 = Y\n+Crc32 = Y\n+Adler32&Crc32 =\n+Fixed = Y\n+Dynamic = Y\ndiff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst\nnew file mode 100644\nindex 0000000..bc59ce8\n--- /dev/null\n+++ b/doc/guides/compressdevs/index.rst\n@@ -0,0 +1,13 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2018 Intel Corporation.\n+\n+Compression Device Drivers\n+==========================\n+\n+\n+.. toctree::\n+ :maxdepth: 2\n+ :numbered:\n+\n+ overview\n+ isal\ndiff --git a/doc/guides/compressdevs/isal.rst b/doc/guides/compressdevs/isal.rst\nnew file mode 100644\nindex 0000000..5b6134b\n--- /dev/null\n+++ b/doc/guides/compressdevs/isal.rst\n@@ -0,0 +1,77 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2018 Intel Corporation.\n+\n+ISA-L Compression Poll Mode Driver\n+==================================\n+\n+The ISA-L PMD (**librte_pmd_isal_comp**) provides poll mode compression &\n+decompression driver support for utilizing Intel ISA-L library,\n+which implements the deflate algorithm for both compression and decompression\n+\n+Features\n+--------\n+\n+ISA-L PMD has support for:\n+\n+Compression/Decompression algorithm:\n+\n+* DEFLATE\n+\n+Huffman code type:\n+\n+* FIXED\n+* DYNAMIC\n+\n+Checksum support:\n+\n+* Adler32\n+* CRC32\n+\n+Window size support:\n+\n+* 32K\n+\n+Limitations\n+-----------\n+\n+* Chained mbufs are not supported.\n+\n+* Compressdev level 0, no compression, is not supported. ISA-L level 0 used for fixed huffman codes.\n+\n+Installation\n+------------\n+\n+* To build DPDK with Intel's ISA-L library, the user is required to download the library from `<https://github.com/01org/isa-l>`_.\n+\n+* Once downloaded, the user needs to build the library, the ISA-L autotools are usually sufficient::\n+\n+ ./autogen.sh\n+ ./configure\n+\n+* make can be used to install the library on their system, before building DPDK::\n+\n+ make\n+ sudo make install\n+\n+* To build with meson, the **libisal.pc** file, must be copied into \"pkgconfig\", e.g. /usr/lib/pkgconfig or /usr/lib64/pkgconfig depending on your system, for meson to find the ISA-L library. The **libisal.pc** is located in library sources::\n+\n+ cp isal/libisal.pc /usr/lib/pkgconfig/\n+\n+\n+Initialization\n+--------------\n+\n+In order to enable this virtual compression PMD, user must:\n+\n+* Set ``CONFIG_RTE_LIBRTE_PMD_ISAL=y`` in config/common_base.\n+\n+To use the PMD in an application, user must:\n+\n+* Call ``rte_vdev_init(\"compress_isal\")`` within the application.\n+\n+* Use ``--vdev=\"compress_isal\"`` in the EAL options, which will call ``rte_vdev_init()`` internally.\n+\n+The following parameter (optional) can be provided in the previous two calls:\n+\n+* ``socket_id:`` Specify the socket where the memory for the device is going to be allocated\n+ (by default, socket_id will be the socket where the core that is creating the PMD is running on).\ndiff --git a/doc/guides/compressdevs/overview.rst b/doc/guides/compressdevs/overview.rst\nnew file mode 100644\nindex 0000000..ca37de1\n--- /dev/null\n+++ b/doc/guides/compressdevs/overview.rst\n@@ -0,0 +1,12 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2018 Intel Corporation.\n+\n+Compression Device Supported Functionality Matrices\n+===================================================\n+\n+Supported Feature Flags\n+-----------------------\n+\n+.. _table_compression_pmd_features:\n+\n+.. include:: overview_feature_table.txt\ndiff --git a/doc/guides/compressdevs/overview_feature_table.txt b/doc/guides/compressdevs/overview_feature_table.txt\nnew file mode 100644\nindex 0000000..8efa231\n--- /dev/null\n+++ b/doc/guides/compressdevs/overview_feature_table.txt\n@@ -0,0 +1,84 @@\n+\n+.. raw:: html\n+\n+ <style>\n+ .wy-nav-content {\n+ opacity: .99;\n+ }\n+ table#id1 {\n+ cursor: default;\n+ overflow: hidden;\n+ }\n+ table#id1 th, table#id1 td {\n+ text-align: center;\n+ }\n+ table#id1 th {\n+ font-size: 72%;\n+ white-space: pre-wrap;\n+ vertical-align: top;\n+ padding: 0.5em 0;\n+ min-width: 0.9em;\n+ width: 2em;\n+ }\n+ table#id1 col:first-child {\n+ width: 0;\n+ }\n+ table#id1 th:first-child {\n+ vertical-align: bottom;\n+ }\n+ table#id1 td {\n+ font-size: 70%;\n+ padding: 1px;\n+ }\n+ table#id1 td:first-child {\n+ padding-left: 1em;\n+ text-align: left;\n+ }\n+ table#id1 tr:nth-child(2n-1) td {\n+ background-color: rgba(210, 210, 210, 0.2);\n+ }\n+ table#id1 th:not(:first-child):hover,\n+ table#id1 td:not(:first-child):hover {\n+ position: relative;\n+ }\n+ table#id1 th:not(:first-child):hover::after,\n+ table#id1 td:not(:first-child):hover::after {\n+ content: '';\n+ height: 6000px;\n+ top: -3000px;\n+ width: 100%;\n+ left: 0;\n+ position: absolute;\n+ z-index: -1;\n+ background-color: #ffb;\n+ }\n+ table#id1 tr:hover td {\n+ background-color: #ffb;\n+ }\n+ </style>\n+\n+.. table:: Features availability in compression drivers\n+\n+ ========================= =\n+ Feature i\n+ s\n+ a\n+ l\n+ ========================= =\n+ HW Accelerated\n+ CPU SSE Y\n+ CPU AVX Y\n+ CPU AVX2 Y\n+ CPU AVX512 Y\n+ CPU NEON\n+ Stateful\n+ By-Pass\n+ Chained mbufs\n+ Deflate Y\n+ LZS\n+ Adler32 Y\n+ Crc32 Y\n+ Adler32&Crc32\n+ Fixed Y\n+ Dynamic Y\n+ ========================= =\ndiff --git a/doc/guides/conf.py b/doc/guides/conf.py\nindex 38de280..c883306 100644\n--- a/doc/guides/conf.py\n+++ b/doc/guides/conf.py\n@@ -388,6 +388,11 @@ def setup(app):\n 'AEAD',\n 'AEAD algorithms in crypto drivers',\n 'AEAD algorithm')\n+ table_file = dirname(__file__) + '/compressdevs/overview_feature_table.txt'\n+ generate_overview_table(table_file, 1,\n+ 'Features',\n+ 'Features availability in compression drivers',\n+ 'Feature')\n \n if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):\n print('Upgrade sphinx to version >= 1.3.1 for '\ndiff --git a/doc/guides/index.rst b/doc/guides/index.rst\nindex d60529d..18fe0ec 100644\n--- a/doc/guides/index.rst\n+++ b/doc/guides/index.rst\n@@ -17,6 +17,7 @@ DPDK documentation\n nics/index\n bbdevs/index\n cryptodevs/index\n+ compressdevs/index\n eventdevs/index\n mempool/index\n platform/index\ndiff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst\nindex ce70d1f..d6a9d6f 100644\n--- a/doc/guides/rel_notes/release_18_05.rst\n+++ b/doc/guides/rel_notes/release_18_05.rst\n@@ -78,7 +78,8 @@ New Features\n * **Added a new compression poll mode driver using Intels ISA-L.**\n \n Added the new ``ISA-L`` compression driver, for compression and decompression\n- operations in software.\n+ operations in software. See the :doc:`../compressdevs/isal` compression driver\n+ guide for details on this new driver.\n \n \n API Changes\n", "prefixes": [ "dpdk-dev", "v4", "10/10" ] }