Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/48321/?format=api
http://patches.dpdk.org/api/patches/48321/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com/", "project": { "id": 1, "url": "http://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": "<1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com", "date": "2018-11-23T14:27:47", "name": "[v4,3/5] doc/guides/tools: add doc files", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "f9dbcd32add38501e21e8e651881cc052c0ff829", "submitter": { "id": 949, "url": "http://patches.dpdk.org/api/people/949/?format=api", "name": "Tomasz Jozwiak", "email": "tomaszx.jozwiak@intel.com" }, "delegate": { "id": 6690, "url": "http://patches.dpdk.org/api/users/6690/?format=api", "username": "akhil", "first_name": "akhil", "last_name": "goyal", "email": "gakhil@marvell.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com/mbox/", "series": [ { "id": 2556, "url": "http://patches.dpdk.org/api/series/2556/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=2556", "date": "2018-11-23T14:27:44", "name": "add initial version of compress-perf", "version": 4, "mbox": "http://patches.dpdk.org/series/2556/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/48321/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/48321/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 1A42D1B5AB;\n\tFri, 23 Nov 2018 15:28:06 +0100 (CET)", "from mga12.intel.com (mga12.intel.com [192.55.52.136])\n\tby dpdk.org (Postfix) with ESMTP id 420731B590\n\tfor <dev@dpdk.org>; Fri, 23 Nov 2018 15:27:59 +0100 (CET)", "from fmsmga002.fm.intel.com ([10.253.24.26])\n\tby fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t23 Nov 2018 06:27:58 -0800", "from tjozwiax-mobl.ger.corp.intel.com (HELO localhost.localdomain)\n\t([10.103.104.46])\n\tby fmsmga002.fm.intel.com with ESMTP; 23 Nov 2018 06:27:57 -0800" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.56,270,1539673200\"; d=\"scan'208\";a=\"107096024\"", "From": "Tomasz Jozwiak <tomaszx.jozwiak@intel.com>", "To": "dev@dpdk.org, fiona.trahe@intel.com, tomaszx.jozwiak@intel.com,\n\tShally.Verma@cavium.com, akhil.goyal@nxp.com", "Date": "Fri, 23 Nov 2018 15:27:47 +0100", "Message-Id": "<1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com>", "X-Mailer": "git-send-email 2.7.4", "In-Reply-To": "<1542983269-30093-1-git-send-email-tomaszx.jozwiak@intel.com>", "References": "<1542978409-28668-1-git-send-email-tomaszx.jozwiak@intel.com>\n\t<1542983269-30093-1-git-send-email-tomaszx.jozwiak@intel.com>", "Subject": "[dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files", "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://mails.dpdk.org/options/dev>,\n\t<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\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Added:\n - initial version of compression performance test\n description file.\n - release note in release_18_11.rst\n\nUpdated index.rst file\n\nSigned-off-by: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>\nSigned-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>\n---\n MAINTAINERS | 5 +++\n doc/guides/rel_notes/release_18_11.rst | 5 +++\n doc/guides/tools/comp_perf.rst | 75 ++++++++++++++++++++++++++++++++++\n doc/guides/tools/index.rst | 1 +\n 4 files changed, 86 insertions(+)\n create mode 100644 doc/guides/tools/comp_perf.rst", "diff": "diff --git a/MAINTAINERS b/MAINTAINERS\nindex 71ba312..dd0c131 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -1242,6 +1242,11 @@ M: Bernard Iremonger <bernard.iremonger@intel.com>\n F: app/test-pmd/\n F: doc/guides/testpmd_app_ug/\n \n+Compression performance test application\n+M: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>\n+F: app/test-compress-perf/\n+F: doc/guides/tools/comp_perf.rst\n+\n Crypto performance test application\n M: Declan Doherty <declan.doherty@intel.com>\n F: app/test-crypto-perf/\ndiff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst\nindex 32ff0e5..d44cf30 100644\n--- a/doc/guides/rel_notes/release_18_11.rst\n+++ b/doc/guides/rel_notes/release_18_11.rst\n@@ -328,6 +328,11 @@ New Features\n additional command-line parameter values from the \"DPDK_TEST_PARAMS\"\n environment variable to make this application easier to use.\n \n+* **Added a compression performance test tool.**\n+\n+ Added a new performance test tool to test the compressdev PMD. The tool tests\n+ compression ratio and compression throughput. Dynamic compression test is not\n+ supported yet.\n \n API Changes\n -----------\ndiff --git a/doc/guides/tools/comp_perf.rst b/doc/guides/tools/comp_perf.rst\nnew file mode 100644\nindex 0000000..1428348\n--- /dev/null\n+++ b/doc/guides/tools/comp_perf.rst\n@@ -0,0 +1,75 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2018 Intel Corporation.\n+\n+dpdk-test-compress-perf Application\n+===================================\n+\n+The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit (DPDK)\n+utility that allows measuring performance parameters of PMDs available in the\n+compress tree. The application reads the data from a file (--input-file),\n+dumps all the file into a buffer and fills out the data of input mbufs,\n+which are passed to compress device with compression operations.\n+Then, the output buffers are fed into the decompression stage, and the resulting\n+data is compared against the original data (verification phase). After that,\n+a number of iterations are performed, compressing first and decompressing later,\n+to check the throughput rate\n+(showing cycles/iteration, cycles/Byte and Gbps, for compression and decompression).\n+\n+\n+Limitations\n+~~~~~~~~~~~\n+\n+* Only supports the fixed compression and stateless operation.\n+\n+Command line options\n+--------------------\n+\n+ ``--driver-name NAME``: compress driver to use\n+\n+ ``--input-file NAME``: file to compress and decompress\n+\n+ ``--extended-input-sz N``: extend file data up to this size (default: no extension)\n+\n+ ``--seg-sz N``: size of segment to store the data (default: 2048)\n+\n+ ``--burst-sz N``: compress operation burst size\n+\n+ ``--pool-sz N``: mempool size for compress operations/mbufs (default: 8192)\n+\n+ ``--max-num-sgl-segs N``: maximum number of segments for each mbuf (default: 16)\n+\n+ ``--num-iter N``: number of times the file will be compressed/decompressed (default: 10000)\n+\n+ ``--operation [comp/decomp/comp_and_decomp]``: perform test on compression, decompression or both operations\n+\n+ ``--huffman-enc [fixed/default]``: Huffman encoding (default: fixed)\n+\n+ ``--compress-level N``: compression level, which could be a single value, list or range (default: range between 1 and 9)\n+\n+ ``--window-sz N``: base two log value of compression window size (default: max supported by PMD)\n+\n+ ``-h``: prints this help\n+\n+\n+Compiling the Application\n+-------------------------\n+\n+**Step 1: PMD setting**\n+\n+The ``dpdk-test-compress-perf`` tool depends on compression device drivers PMD which\n+can be disabled by default in the build configuration file ``common_base``.\n+The compression device drivers PMD which should be tested can be enabled by setting::\n+\n+ CONFIG_RTE_LIBRTE_PMD_ISAL=y\n+\n+\n+Running the Application\n+-----------------------\n+\n+The tool application has a number of command line options. Here is the sample command line:\n+\n+.. code-block:: console\n+\n+ ./build/app/dpdk-test-compress-perf -l 4 -- --driver-name compress_qat --input-file test.txt --seg-sz 8192\n+ --compress-level 1:1:9 --num-iter 10 --extended-input-sz 1048576 --max-num-sgl-segs 16 --huffman-enc fixed\n+\ndiff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst\nindex a6e2c4c..24235ba 100644\n--- a/doc/guides/tools/index.rst\n+++ b/doc/guides/tools/index.rst\n@@ -42,3 +42,4 @@ DPDK Tools User Guides\n testbbdev\n cryptoperf\n testeventdev\n+ comp_perf\n", "prefixes": [ "v4", "3/5" ] }{ "id": 48321, "url": "