[v3,3/5] doc/guides/tools: add doc files

  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         | 75 ++++++++++++++++++++++++++++++++++
 doc/guides/tools/index.rst             |  1 +
 4 files changed, 86 insertions(+)
 create mode 100644 doc/guides/tools/comp_perf.rst
  

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?
  

> -----Original Message-----
> From: Varghese, Vipin
> Sent: Friday, November 23, 2018 3:53 PM
> To: Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; dev@dpdk.org; Trahe,
> Fiona <fiona.trahe@intel.com>; Jozwiak, TomaszX
> <tomaszx.jozwiak@intel.com>; Shally.Verma@cavium.com;
> akhil.goyal@nxp.com
> Subject: RE: [dpdk-dev] [PATCH v3 3/5] doc/guides/tools: add doc files
> 
> Hi Tomasz,
> 
> <snipped>
> 
> > +dpdk-test-compress-perf Application
> > +===================================
> > +
> 
> Suggestion to remove extra '='
True , Thx



> 
> > +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?

'tool application' will change this.

> 
> > +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 '~'

True, will do

> 
> > +* Only supports the fixed compression and stateless operation.
> > +
> 
> Is the limitation of the application that it will not cover stateful?

In that initial version yes. Will be updated in future versions.


> 
> > +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?

No, should be eg.:
Will update this

> 
> > +
> > +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?

True, will update this, Thx

--
Tomek