From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-BY2-obe.outbound.protection.outlook.com (mail-eopbgr810055.outbound.protection.outlook.com [40.107.81.55]) by dpdk.org (Postfix) with ESMTP id 960615911 for ; Mon, 5 Nov 2018 09:57:35 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=MkdZCTOKP8Yg2UUHaGd2dLhQOtEyPuNDcthWipaSJzY=; b=WQJ3mHOdsnD8Slp9GdW7PAzwdAZ7zADF07u20BdU9g/mt1xcCzq9ms8ZgvB/eO9/4iAypZi057H2QH9E8lGy+wUgES7W5fuMVnyrRJ7mHFpcrfFJIBelw/0BRWzHrzuelAFpY8+EZbhsn/UryaCd5O/akiaJSxLo0R+nlWQF7CU= Received: from SN6PR07MB5152.namprd07.prod.outlook.com (52.135.101.33) by SN6PR07MB4685.namprd07.prod.outlook.com (52.135.77.12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1294.23; Mon, 5 Nov 2018 08:57:33 +0000 Received: from SN6PR07MB5152.namprd07.prod.outlook.com ([fe80::49cb:b2a:974:2211]) by SN6PR07MB5152.namprd07.prod.outlook.com ([fe80::49cb:b2a:974:2211%4]) with mapi id 15.20.1294.028; Mon, 5 Nov 2018 08:57:33 +0000 From: "Verma, Shally" To: Tomasz Jozwiak , "dev@dpdk.org" , "fiona.trahe@intel.com" , "akhil.goyal@nxp.com" Thread-Topic: [PATCH v2 3/3] doc/guides/tools: add doc files Thread-Index: AQHUcpCdHNfEDnNcEEiJoMz03BghuqVA4pew Date: Mon, 5 Nov 2018 08:57:33 +0000 Message-ID: References: <1538400427-20164-1-git-send-email-tomaszx.jozwiak@intel.com> <1541151842-8746-1-git-send-email-tomaszx.jozwiak@intel.com> <1541151842-8746-4-git-send-email-tomaszx.jozwiak@intel.com> In-Reply-To: <1541151842-8746-4-git-send-email-tomaszx.jozwiak@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; x-originating-ip: [115.113.156.3] x-ms-publictraffictype: Email x-microsoft-exchange-diagnostics: 1; SN6PR07MB4685; 6:DKA2cuJGu08Xs8YN8fOHEinebBiPSAXjwFsSsHXw3tUb80P2yG3sLgPHZRRgas1n8f2Urx3BimE6/fqGuzy6bSIhzVhrkC8M7v5dTd7VhAzd4+vOxZqgUQwKTOGzmhV7hOPJt+bm4C5YSbobNS7PKXqCTEOWYrEhCK/5lI468fOJ6lMUy+gNSSvbc6AxXw/Vz+YQalUYiYZbSbnqQHUII1DhAB4qKjnn8Op9LshENYPMm6eOXOHmD02pDpLzaZgZb7yoa9D6eQXF8OpsvqLpXMot6a0ZinTZXdE+QWqic76KoZdIJH5e0lgyyJVLtr2n6ohDhiBd6Kj0E2gG03sx0txDBQdNvCpxMIRSFrPrW+SOPqq7R9eZhmCQIE9kwYWETkTrHl+mYHI5v6CQPnX3dfa5+TYhPNs5kMiZyo3/FXkp4dCMaZhNeIzmMG8KIrYfJxlmWGesK/+rdTVkzImu9w==; 5:oP1zxyyzRzbqwBJKqeyfEkupdVi2868IexvUfFgN4jIjcRuQj80QtiqujvsL2XARGfXEnd2vtBPa57UluQ7a0q+RiJsbU/v35k1VJ6waXjJG/8Uk/XW7WjGmyq6irjckbtR4IHsHQQ6GC7oiIcz8LtKPFUYqx5Cf0C4dagEpCQc=; 7:QZVPXm471o+XK83eVr/1cT9uUf5oDZC7m3+ybqjXJFm8UMMV5+DyBJJckEybJ7d5JWSOn2SjKtmIgUzUnitr3guUfIj55XCoJNPjxaAMJ7PcpSLESYxj1GSPCI0b0gedqGylcf01zHY/XDZkkZEp1Q== x-ms-exchange-antispam-srfa-diagnostics: SOS; x-ms-office365-filtering-correlation-id: c59650ce-5492-4502-dea4-08d642fcb9bf x-microsoft-antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(5600074)(711020)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(2017052603328)(7153060)(7193020); SRVR:SN6PR07MB4685; x-ms-traffictypediagnostic: SN6PR07MB4685: x-microsoft-antispam-prvs: x-exchange-antispam-report-test: UriScan:(228905959029699)(185117386973197); x-ms-exchange-senderadcheck: 1 x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3231382)(944501410)(52105095)(10201501046)(93006095)(93001095)(3002001)(148016)(149066)(150057)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123558120)(20161123562045)(20161123564045)(20161123560045)(201708071742011)(7699051)(76991095); SRVR:SN6PR07MB4685; BCL:0; PCL:0; RULEID:; SRVR:SN6PR07MB4685; x-forefront-prvs: 08476BC6EF x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(346002)(376002)(396003)(366004)(39860400002)(136003)(189003)(199004)(13464003)(14444005)(256004)(102836004)(186003)(2900100001)(86362001)(476003)(11346002)(446003)(81166006)(8676002)(66066001)(26005)(486006)(8936002)(81156014)(55236004)(110136005)(316002)(6506007)(7736002)(2201001)(7696005)(105586002)(106356001)(76176011)(305945005)(74316002)(71200400001)(71190400001)(68736007)(2906002)(478600001)(72206003)(2501003)(99286004)(229853002)(97736004)(3846002)(6116002)(6436002)(5660300001)(25786009)(33656002)(9686003)(53936002)(55016002)(6246003)(14454004); DIR:OUT; SFP:1101; SCL:1; SRVR:SN6PR07MB4685; H:SN6PR07MB5152.namprd07.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; received-spf: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) x-microsoft-antispam-message-info: rfLog9Q7WQh9afmRSM3+A2MWCmuBBbSCub1cCZvKRNOiPZJrbeODHNmIYafUQDQxV63qzoZDsBTW5G4/jzJvNpDuyidiTDBhvZ0ZOIzhI2q032/0kSI4NSNAkWkgW9yfLliKM8jTdwimVHvknpD2mubFjXDFfyNAkT73iwCrKFPtoYtBs/nTRrB3QmFtH5QUgIqjWvCS6mnUEHFBtx17DynO2FpzlGcnNmqM00Mjym/L62aAceF1MPrf8LUfQLh9mo5bGFTQgd8nUh9AKY17RW6XVgfXdPmsjlifX2M0MG+Aw9s9EddTcjMJNUwm+nnQ39AWmH948pQ+8NvkQNokRCVIQG5mAsFQXX8VfmurI7M= spamdiagnosticoutput: 1:99 spamdiagnosticmetadata: NSPM Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: cavium.com X-MS-Exchange-CrossTenant-Network-Message-Id: c59650ce-5492-4502-dea4-08d642fcb9bf X-MS-Exchange-CrossTenant-originalarrivaltime: 05 Nov 2018 08:57:33.3734 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN6PR07MB4685 Subject: Re: [dpdk-dev] [PATCH v2 3/3] 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: Mon, 05 Nov 2018 08:57:36 -0000 >-----Original Message----- >From: Tomasz Jozwiak >Sent: 02 November 2018 15:14 >To: dev@dpdk.org; fiona.trahe@intel.com; tomaszx.jozwiak@intel.com; Verma,= Shally ; >akhil.goyal@nxp.com >Subject: [PATCH v2 3/3] doc/guides/tools: add doc files > >External Email > >Added: > - initial version of compression performance test > description file. > - release note in release_18_11.rst > >Signed-off-by: De Lara Guarch, Pablo >Signed-off-by: Tomasz Jozwiak >--- > MAINTAINERS | 5 +++ > doc/guides/rel_notes/release_18_11.rst | 6 +++ > doc/guides/tools/comp_perf.rst | 75 +++++++++++++++++++++++++++++= +++++ > 3 files changed, 86 insertions(+) > create mode 100644 doc/guides/tools/comp_perf.rst > >diff --git a/MAINTAINERS b/MAINTAINERS >index e60379d..cfda6dd 100644 >--- a/MAINTAINERS >+++ b/MAINTAINERS >@@ -1242,6 +1242,11 @@ M: Bernard Iremonger > F: app/test-pmd/ > F: doc/guides/testpmd_app_ug/ > >+Compression performance test application >+M: De Lara Guarch, Pablo >+F: app/test-compress-perf/ >+F: doc/guides/tools/comp_perf.rst >+ > 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 376128f..8bc7d05 100644 >--- a/doc/guides/rel_notes/release_18_11.rst >+++ b/doc/guides/rel_notes/release_18_11.rst >@@ -285,6 +285,12 @@ New Features > this application doesn't need to launch dedicated worker threads for vh= ost > enqueue/dequeue operations. > >+* **Added a compression performance test tool.** >+ >+ Added a new performance test tool to test the compressdev PMD. The too= l 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.r= st >new file mode 100644 >index 0000000..2f43412 >--- /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-crypto-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 >+ >+The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit (DPD= K) >+utility that allows measuring performance parameters of PMDs 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 re= sulting >+data is compared against the original data (verification phase). After th= at, >+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 deco= mpression). >+ >+ >+Limitations >+~~~~~~~~~~~ >+ >+* Only supports the fixed compression. Perf app seem to support stateless only for now, so should mention as "supp= orted for fixed and stateless operation only." Thanks Shally >+ >+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: 81= 92) >+ >+ ``--max-num-sgl-segs N``: maximum number of segments for each mbuf (defa= ult: 16) >+ >+ ``--num-iter N``: number of times the file will be compressed/decompress= ed (default: 10000) >+ >+ ``--operation [comp/decomp/comp_and_decomp]``: perform test on compressi= on, 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 (defaul= t: 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 driver= s 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 >+ >+ >+Running the Application >+----------------------- >+ >+The tool application has a number of command line options. Here is the sa= mple command line: >+ >+.. code-block:: console >+ >+ ./build/app/dpdk-test-compress-perf -l 4 -- --driver-name compress_qa= t --input-file test.txt --seg-sz 8192 >+ --compress-level 1:1:9 --num-iter 10 --extended-input-sz 1048576 --m= ax-num-sgl-segs 16 --huffman-enc fixed >+ >-- >2.7.4