From: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>
To: dev@dpdk.org, fiona.trahe@intel.com, tomaszx.jozwiak@intel.com,
Shally.Verma@cavium.com, akhil.goyal@nxp.com
Subject: [dpdk-dev] [PATCH v5 3/5] doc/guides/tools: add doc files
Date: Wed, 5 Dec 2018 09:47:04 +0100 [thread overview]
Message-ID: <1543999626-24262-4-git-send-email-tomaszx.jozwiak@intel.com> (raw)
In-Reply-To: <1543999626-24262-1-git-send-email-tomaszx.jozwiak@intel.com>
Added:
- initial version of compression performance test
description file.
- release note in release_18_11.rst
Updated index.rst file
Signed-off-by: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
Signed-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>
---
MAINTAINERS | 5 +++
doc/guides/rel_notes/release_18_11.rst | 5 +++
doc/guides/tools/comp_perf.rst | 81 ++++++++++++++++++++++++++++++++++
doc/guides/tools/index.rst | 1 +
4 files changed, 92 insertions(+)
create mode 100644 doc/guides/tools/comp_perf.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 71ba312..dd0c131 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1242,6 +1242,11 @@ M: Bernard Iremonger <bernard.iremonger@intel.com>
F: app/test-pmd/
F: doc/guides/testpmd_app_ug/
+Compression performance test application
+M: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
+F: app/test-compress-perf/
+F: doc/guides/tools/comp_perf.rst
+
Crypto performance test application
M: Declan Doherty <declan.doherty@intel.com>
F: app/test-crypto-perf/
diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
index 65bab55..e6652a5 100644
--- a/doc/guides/rel_notes/release_18_11.rst
+++ b/doc/guides/rel_notes/release_18_11.rst
@@ -352,6 +352,11 @@ New Features
additional command-line parameter values from the ``DPDK_TEST_PARAMS``
environment variable to make this application easier to use.
+* **Added a compression performance test tool.**
+
+ Added a new performance test tool to test the compressdev PMD. The tool tests
+ compression ratio and compression throughput. Dynamic compression test is not
+ supported yet.
API Changes
-----------
diff --git a/doc/guides/tools/comp_perf.rst b/doc/guides/tools/comp_perf.rst
new file mode 100644
index 0000000..d343408
--- /dev/null
+++ b/doc/guides/tools/comp_perf.rst
@@ -0,0 +1,81 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2018 Intel Corporation.
+
+dpdk-test-compress-perf Tool
+============================
+
+The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit (DPDK)
+utility that allows measuring performance parameters of PMDs available in the
+compress tree. The tool reads the data from a file (--input-file),
+dumps all the file into a buffer and fills out the data of input mbufs,
+which are passed to compress device with compression operations.
+Then, the output buffers are fed into the decompression stage, and the resulting
+data is compared against the original data (verification phase). After that,
+a number of iterations are performed, compressing first and decompressing later,
+to check the throughput rate
+(showing cycles/iteration, cycles/Byte and Gbps, for compression and decompression).
+
+.. Note::
+
+ if the max-num-sgl-segs x seg_sz > input size then segments number in
+ the chain will be lower than value passed into max-num-sgl-segs.
+
+
+Limitations
+~~~~~~~~~~~
+
+* Stateful operation and dynamic compression are not supported in this version.
+
+
+Command line options
+--------------------
+
+ ``--driver-name NAME``: compress driver to use
+
+ ``--input-file NAME``: file to compress and decompress
+
+ ``--extended-input-sz N``: extend file data up to this size (default: no extension)
+
+ ``--seg-sz N``: size of segment to store the data (default: 2048)
+
+ ``--burst-sz N``: compress operation burst size
+
+ ``--pool-sz N``: mempool size for compress operations/mbufs (default: 8192)
+
+ ``--max-num-sgl-segs N``: maximum number of segments for each mbuf (default: 16)
+
+ ``--num-iter N``: number of times the file will be compressed/decompressed (default: 10000)
+
+ ``--operation [comp/decomp/comp_and_decomp]``: perform test on compression, decompression or both operations
+
+ ``--huffman-enc [fixed/default]``: Huffman encoding (default: fixed)
+
+ ``--compress-level N``: compression level, which could be a single value, list or range (default: range between 1 and 9)
+
+ ``--window-sz N``: base two log value of compression window size (default: max supported by PMD)
+
+ ``-h``: prints this help
+
+
+Compiling the Tool
+------------------
+
+**Step 1: PMD setting**
+
+The ``dpdk-test-compress-perf`` tool depends on compression device drivers PMD which
+can be disabled by default in the build configuration file ``common_base``.
+The compression device drivers PMD which should be tested can be enabled by setting e.g.::
+
+ CONFIG_RTE_LIBRTE_PMD_ISAL=y
+
+
+Running the Tool
+----------------
+
+The tool has a number of command line options. Here is the sample command line:
+
+.. code-block:: console
+
+ ./build/app/dpdk-test-compress-perf -l 4 -- --driver-name compress_qat --input-file test.txt --seg-sz 8192
+ --compress-level 1:1:9 --num-iter 10 --extended-input-sz 1048576 --max-num-sgl-segs 16 --huffman-enc fixed
+
diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst
index a6e2c4c..24235ba 100644
--- a/doc/guides/tools/index.rst
+++ b/doc/guides/tools/index.rst
@@ -42,3 +42,4 @@ DPDK Tools User Guides
testbbdev
cryptoperf
testeventdev
+ comp_perf
--
2.7.4
next prev parent reply other threads:[~2018-12-05 8:47 UTC|newest]
Thread overview: 76+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-01 13:27 [dpdk-dev] [PATCH 0/3] app: add initial version of compress-perf Tomasz Jozwiak
2018-10-01 13:27 ` [dpdk-dev] [PATCH 1/3] app/compress-perf: add parser Tomasz Jozwiak
2018-10-01 13:27 ` [dpdk-dev] [PATCH 2/3] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-10-12 10:15 ` Verma, Shally
2018-10-15 15:10 ` Daly, Lee
2018-10-16 5:18 ` Verma, Shally
2018-10-17 14:33 ` Trahe, Fiona
2018-10-17 15:42 ` Verma, Shally
2018-10-17 16:45 ` Trahe, Fiona
2018-10-17 16:47 ` Verma, Shally
2018-11-30 14:43 ` Jozwiak, TomaszX
2018-12-02 6:39 ` Verma, Shally
2018-12-05 8:51 ` Jozwiak, TomaszX
2018-11-02 9:59 ` Jozwiak, TomaszX
2018-11-05 8:34 ` Verma, Shally
2018-11-06 8:04 ` Jozwiak, TomaszX
2018-11-06 8:15 ` Verma, Shally
2018-11-06 9:05 ` Jozwiak, TomaszX
2018-11-06 15:39 ` Verma, Shally
2018-11-07 10:18 ` Jozwiak, TomaszX
2018-11-10 0:54 ` Trahe, Fiona
2018-11-12 4:45 ` Verma, Shally
2018-10-01 13:27 ` [dpdk-dev] [PATCH 3/3] doc/guides/tools: add doc file Tomasz Jozwiak
2018-10-16 9:26 ` Kovacevic, Marko
2018-11-02 9:43 ` [dpdk-dev] [PATCH v2 0/3] add initial version of compress-perf Tomasz Jozwiak
2018-11-02 9:44 ` [dpdk-dev] [PATCH v2 1/3] app/compress-perf: add parser Tomasz Jozwiak
2018-11-05 8:40 ` Verma, Shally
2018-11-06 8:30 ` Jozwiak, TomaszX
2018-11-06 8:32 ` Verma, Shally
2018-11-02 9:44 ` [dpdk-dev] [PATCH v2 2/3] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-11-05 8:56 ` Verma, Shally
2018-11-06 8:49 ` Jozwiak, TomaszX
2018-11-06 15:37 ` Verma, Shally
2018-11-07 10:14 ` Jozwiak, TomaszX
2018-11-02 9:44 ` [dpdk-dev] [PATCH v2 3/3] doc/guides/tools: add doc files Tomasz Jozwiak
2018-11-05 8:57 ` Verma, Shally
2018-11-06 8:51 ` Jozwiak, TomaszX
2018-11-02 11:04 ` [dpdk-dev] [PATCH v2 0/3] add initial version of compress-perf Bruce Richardson
2018-11-02 11:12 ` Jozwiak, TomaszX
2018-11-23 13:06 ` [dpdk-dev] [PATCH v3 0/5] " Tomasz Jozwiak
2018-11-23 13:06 ` [dpdk-dev] [PATCH v3 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-11-23 13:06 ` [dpdk-dev] [PATCH v3 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-11-23 13:06 ` [dpdk-dev] [PATCH v3 3/5] doc/guides/tools: add doc files Tomasz Jozwiak
2018-11-23 14:52 ` Varghese, Vipin
2018-11-23 14:59 ` Jozwiak, TomaszX
2018-11-23 13:06 ` [dpdk-dev] [PATCH v3 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-11-23 13:06 ` [dpdk-dev] [PATCH v3 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-11-23 14:27 ` [dpdk-dev] [PATCH v4 0/5] add initial version of compress-perf Tomasz Jozwiak
2018-11-23 14:27 ` [dpdk-dev] [PATCH v4 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-11-23 15:10 ` Varghese, Vipin
2018-11-23 15:24 ` Bruce Richardson
2018-11-23 15:42 ` Jozwiak, TomaszX
2018-11-23 14:27 ` [dpdk-dev] [PATCH v4 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-11-23 14:27 ` [dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files Tomasz Jozwiak
2018-11-23 15:00 ` Varghese, Vipin
2018-11-23 15:12 ` Jozwiak, TomaszX
2018-11-23 15:26 ` Varghese, Vipin
2018-11-23 14:27 ` [dpdk-dev] [PATCH v4 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-11-23 14:27 ` [dpdk-dev] [PATCH v4 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-12-05 8:47 ` [dpdk-dev] [PATCH v5 0/5] add initial version of compress-perf Tomasz Jozwiak
2018-12-05 8:47 ` [dpdk-dev] [PATCH v5 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-12-05 8:47 ` [dpdk-dev] [PATCH v5 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-12-05 8:47 ` Tomasz Jozwiak [this message]
2018-12-05 8:47 ` [dpdk-dev] [PATCH v5 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-12-05 8:47 ` [dpdk-dev] [PATCH v5 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-12-05 15:37 ` [dpdk-dev] [PATCH v5 0/5] add initial version of compress-perf Daly, Lee
2018-12-12 11:54 ` [dpdk-dev] [PATCH v6 " Tomasz Jozwiak
2018-12-17 11:11 ` Verma, Shally
2018-12-12 12:08 ` Tomasz Jozwiak
2018-12-12 12:08 ` [dpdk-dev] [PATCH v6 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-12-12 12:08 ` [dpdk-dev] [PATCH v6 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-12-12 12:08 ` [dpdk-dev] [PATCH v6 3/5] doc/guides/tools: add doc files Tomasz Jozwiak
2018-12-12 12:08 ` [dpdk-dev] [PATCH v6 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-12-12 12:08 ` [dpdk-dev] [PATCH v6 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-12-14 19:24 ` [dpdk-dev] [PATCH v6 0/5] add initial version of compress-perf Trahe, Fiona
2018-12-18 10:28 ` Akhil Goyal
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=1543999626-24262-4-git-send-email-tomaszx.jozwiak@intel.com \
--to=tomaszx.jozwiak@intel.com \
--cc=Shally.Verma@cavium.com \
--cc=akhil.goyal@nxp.com \
--cc=dev@dpdk.org \
--cc=fiona.trahe@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).