[dpdk-dev] [PATCH v3 3/5] doc/guides/tools: add doc files

Varghese, Vipin vipin.varghese at intel.com
Fri Nov 23 15:52:40 CET 2018


Hi Tomasz,

<snipped>

> +dpdk-test-compress-perf Application
> +===================================
> +

Suggestion to remove extra '='

> +The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit
> +(DPDK) utility that allows measuring performance parameters of PMDs

Is this test application or utility like procinfo or pdump?

> +available in the compress tree. The application 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).
> +
> +
> +Limitations
> +~~~~~~~~~~~
> +

Suggestion to remove extra '~'

> +* Only supports the fixed compression and stateless operation.
> +

Is the limitation of the application that it will not cover stateful?

> +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 Application
> +-------------------------
> +
> +**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::
> +
> +   CONFIG_RTE_LIBRTE_PMD_ISAL=y
> +

Does this application only run with ISAL? If yes will it be ok to mention this in limitation?

> +
> +Running the Application
> +-----------------------
> +
> +The tool application has a number of command line options. Here is the
> sample command line:
> +

Here we are using 'tool application'. Would either one of application or utility state the right usage?


More information about the dev mailing list