From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 6D9C81B5C9 for ; Fri, 23 Nov 2018 16:00:21 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 23 Nov 2018 07:00:20 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,270,1539673200"; d="scan'208";a="102590173" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by orsmga003.jf.intel.com with ESMTP; 23 Nov 2018 07:00:17 -0800 Received: from fmsmsx118.amr.corp.intel.com (10.18.116.18) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.408.0; Fri, 23 Nov 2018 07:00:17 -0800 Received: from bgsmsx105.gar.corp.intel.com (10.223.43.197) by fmsmsx118.amr.corp.intel.com (10.18.116.18) with Microsoft SMTP Server (TLS) id 14.3.408.0; Fri, 23 Nov 2018 07:00:17 -0800 Received: from bgsmsx101.gar.corp.intel.com ([169.254.1.234]) by BGSMSX105.gar.corp.intel.com ([169.254.3.64]) with mapi id 14.03.0415.000; Fri, 23 Nov 2018 20:30:13 +0530 From: "Varghese, Vipin" To: "Jozwiak, TomaszX" , "dev@dpdk.org" , "Trahe, Fiona" , "Jozwiak, TomaszX" , "Shally.Verma@cavium.com" , "akhil.goyal@nxp.com" Thread-Topic: [dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files Thread-Index: AQHUgzjV0M14rEG6/UCfHFQ1MAywlqVdcoNA Date: Fri, 23 Nov 2018 15:00:12 +0000 Message-ID: <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2C1AF9@BGSMSX101.gar.corp.intel.com> References: <1542978409-28668-1-git-send-email-tomaszx.jozwiak@intel.com> <1542983269-30093-1-git-send-email-tomaszx.jozwiak@intel.com> <1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com> In-Reply-To: <1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_NT x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYjJmYzBmZTgtNGZiZC00NzA0LWIxM2MtMDNhNzA0OWUxZTY3IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoicGhvSUVIM2wrM1F6VUM1TUhtQm5oN1dZMlBpK25FRUxkNUFIeGQ0ZDZ3a200M29ta2tcLzBBWnlmcjY2dFR5WDcifQ== dlp-product: dlpe-windows dlp-version: 11.0.400.15 dlp-reaction: no-action x-originating-ip: [10.223.10.10] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 23 Nov 2018 15:00:22 -0000 Apologies Tomasz, I shared my comments in v3. sharing for v4 > Crypto performance test application > M: Declan Doherty > 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 32ff0e5..d44cf30 100644 > --- a/doc/guides/rel_notes/release_18_11.rst > +++ b/doc/guides/rel_notes/release_18_11.rst > @@ -328,6 +328,11 @@ New Features > additional command-line parameter values from the "DPDK_TEST_PARAMS" > environment variable to make this application easier to use. >=20 > +* **Added a compression performance test tool.** It is mentioned as test application above, here test tool. Should we make t= his synced? >=20 > API Changes > ----------- > diff --git a/doc/guides/tools/comp_perf.rst b/doc/guides/tools/comp_perf.= rst > new file mode 100644 index 0000000..1428348 > --- /dev/null > +++ b/doc/guides/tools/comp_perf.rst > @@ -0,0 +1,75 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2018 Intel Corporation. > + > +dpdk-test-compress-perf Application > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Should we remove extra '=3D'? > + > +The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit > +(DPDK) utility that allows measuring performance parameters of PMDs Should we keep this as test application? Or is this an utility like pdump o= r procinfo? > + > + > +Limitations > +~~~~~~~~~~~ Extra '~'? > + > +* Only supports the fixed compression and stateless operation. Is 'stateful' not supported a limitation rather than supporting stateless? > + > +Command line options > +-------------------- > + Missing '-' > +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=3Dy Does this test application other PMD? If not can we cover this in limitatio= n? > + > + > +Running the Application > +----------------------- > + > +The tool application has a number of command line options. Here is the > sample command line: Do we need to reword 'tool application' to either 'test application' or 'te= st utility'? > + > +.. code-block:: console > + > + ./build/app/dpdk-test-compress-perf -l 4 -- --driver-name compress_q= at -- > 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 inde= x > 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