From patchwork Tue May 15 10:32:26 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shally Verma X-Patchwork-Id: 40048 X-Patchwork-Delegate: pablo.de.lara.guarch@intel.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 3B0B81BA27; Tue, 15 May 2018 12:33:17 +0200 (CEST) Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-bn3nam01on0059.outbound.protection.outlook.com [104.47.33.59]) by dpdk.org (Postfix) with ESMTP id DECE31BA1C for ; Tue, 15 May 2018 12:33:13 +0200 (CEST) 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; bh=nEAvqWKeonRYpT4ir6OcDSW8vVkPUWHxlR0S15UJxqA=; b=LG/zAQWf89odnLyX0O41MmusHyixnqs1gKN/mjTFjAfdcLxW5g5ReNESDEqbEg+bUZAJmuZ2uhcubjGKMSI8u+wKWkzhB/AwO3DCsXMUN5kgGDznXzFYGRjBhpB4cIrFmKhKlnU2O66K9K7Joy8Zfk9WfFTcz+agzFDaQmrV2RA= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; Received: from hyd1sverma-dt.caveonetworks.com (115.113.156.2) by SN4PR0701MB3646.namprd07.prod.outlook.com (2603:10b6:803:4d::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.755.16; Tue, 15 May 2018 10:33:10 +0000 From: Shally Verma To: pablo.de.lara.guarch@intel.com Cc: fiona.trahe@intel.com, dev@dpdk.org, pathreay@caviumnetworks.com, Sunila Sahu , Ashish Gupta Date: Tue, 15 May 2018 16:02:26 +0530 Message-Id: <1526380346-7386-7-git-send-email-shally.verma@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1526380346-7386-1-git-send-email-shally.verma@caviumnetworks.com> References: <1526380346-7386-1-git-send-email-shally.verma@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: BMXPR01CA0033.INDPRD01.PROD.OUTLOOK.COM (2603:1096:b00:c::19) To SN4PR0701MB3646.namprd07.prod.outlook.com (2603:10b6:803:4d::12) X-MS-PublicTrafficType: Email X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(5600026)(2017052603328)(7153060)(7193020); SRVR:SN4PR0701MB3646; X-Microsoft-Exchange-Diagnostics: 1; SN4PR0701MB3646; 3:acm7M8ssXxjk1zj60A8kfsEpwwD5DpqyLBHUwYEWUCR7YTvHl1YoXmqPzCE4GvSPxbpo4AsE+U5vOo8IhQqZmKeQmGnTLxBVim/GwqyrR+/uPogQwQada7MdDxLys/K2zIjs5gJMBzJZ84uxur7+zC55luGmlpjpIKaS+lrpv+Dob6s+bNQP5AND0CAhUt+MjDLBfAp7SQT2l7+BQS99WFaiLaUOfEp12Hn4VfIjZfjUq3Z/mIfjJefROhdx0cLe; 25:hmd6MV7klvCE0d7v+s8oTg81rBzqwn8bvI9UVbItORObGQ2t1rD4KZWN6bhEE+WYOvD+K9q4ewVYGC4n6ycT653ronFxXH5PnnGbLCVHsLBbn9Tt3vh9dOasof534A4DWmC3kDU/UqG3C7llXWMmjJYAmBiDBHSYAyb/ftoUVVoWQfl747dGRmg7wxGU+qyJPxOb703zd4ksGwM3FiNf3WgSDCXTDnco3Ul3ZhrvA4+sYzGl7AfWFGrJmE1MFyVGzqbNLQWHLF9kY2oQFerDx+be2iFVUD1bztzxHicueEKKL9nCC0l1UahgSlZ1fji1TC0/sv/wGTS1elEx643n5g==; 31:udUVgYdrSnAHIlR6SEySMbrqx0SXPW8VK3nolnf1EGiqiUZUYRYynhjVKGVTcms0P8A/3KLDd8KHijEM8YauQKj6xaBoW5ylMg/Vqdz3kKa02muU1mks37wJyNciuE9gXYSEVeihfQYNpDpUH8t+9kSkAkmidWbMBRXlgFo8v/ppfpMdNTqPvpRJqluVOxNMOyXlKQc1qNNT6+qe4joRnH0PRWr+uToe3KIKcgk0D68= X-MS-TrafficTypeDiagnostic: SN4PR0701MB3646: X-Microsoft-Exchange-Diagnostics: 1; SN4PR0701MB3646; 20:oNCDT3bVpyRam1E6cqJziaiGhz4rGqFSrwM3wIDOIE5avklMIhKG7Ss6N8h+9hoPSt1zwMr9rSPPPdOSckZ14/l7AY79rfumBNnbRdaETGiUyvlQv8j3Xq1tXLpKFb32fXlhuKZlksj/X/gaXlkwsvzFvoPbMjJWfcnquJ4d9Cyor9o2CpA+PAhxQSac0QZciLhkOqezO9zDeeHu5wRckitWUxCBQkqLgHiGBwZtxyOoyV/ycFLlI/V7yL5j2M/c5YtG313UzdTP2lBqGFm8TZOaI+tPIlI6J+FW31LgjYSLPNLoPANt7V3xPUK2+Ww6dIRB+Q8YC6EPO5fPF2VWogmg4V9AIzlFGlESHIofBEh5RwgvslT+lz6L4sKMSIATL6JZ29dndymsFl6oDXtMC4kbcjIsFnbY0qui1ZJMPsKGRf7t3WgTuJ5Q8Wdn6wbjkWQxNsFC0Xyau5+vLc+zX61+8UfJJtmkL2mLgK2RjYAjBuPcHqXpVppwo9915Rjq4/TeiG6/d6KqvMVxCUX3gSypv+85XV8/PqCcOz4FTCLzED4j35ywssosXIxGWQrwhDh6DD9q2IOPp8ujfl86BYt4kQHDQleAlyzlXi68jZs=; 4:zpNaXfXkS6qv1n6/lHvj9DPvBpQWk+dLMM34wRRiVubSZ30A2aGKj0zxHQxsWWOAJmPZUyG6YgDQGGDSQrIyrmkCAP4KCHLtV7V/sauwOyolp5eiuA9v4I3zalk80E05azxJxel7ME+iLrSLLLA8W8gkkRVPP1yu4jPg8DYnmBGoBXAVkp+5kyuv883AT6YtrfQvAI3zAPuazlCRNBO3tjFG0fyCj22+16Qugm2NvuUDvX4QuYF8PVD8cfEfEqePUZnxorzVD+iCnWXkWqPX3A== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3231254)(944501410)(52105095)(93006095)(3002001)(10201501046)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123564045)(20161123562045)(20161123558120)(20161123560045)(6072148)(201708071742011); SRVR:SN4PR0701MB3646; BCL:0; PCL:0; RULEID:; SRVR:SN4PR0701MB3646; X-Forefront-PRVS: 0673F5BE31 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(39380400002)(39860400002)(376002)(366004)(396003)(346002)(189003)(199004)(478600001)(486006)(55236004)(44832011)(16586007)(54906003)(316002)(47776003)(2906002)(59450400001)(6506007)(386003)(8936002)(66066001)(6486002)(72206003)(6116002)(3846002)(25786009)(97736004)(5660300001)(42882007)(50226002)(36756003)(8676002)(48376002)(53416004)(52116002)(107886003)(26005)(50466002)(2616005)(81156014)(105586002)(81166006)(2361001)(53936002)(6666003)(6916009)(4326008)(16526019)(68736007)(476003)(446003)(956004)(106356001)(76176011)(186003)(7736002)(2351001)(69596002)(6512007)(305945005)(51416003)(11346002)(217873001); DIR:OUT; SFP:1101; SCL:1; SRVR:SN4PR0701MB3646; H:hyd1sverma-dt.caveonetworks.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-Exchange-Diagnostics: =?us-ascii?Q?1; SN4PR0701MB3646; 23:XmZwaM+DP4P3jiHM4sXKC08hh9TcuIF8aFKHtFe?= 1nJIuDG0Mqnc8JVTs2V3r0G9PoyEla0QYwSQC51j7Qd8v/ZAYo4HI67QIW/Ui9/Z2XyKbvJsTDvcdM0yIqLVcvImbycQw6tGruCMhK3ju5biHGf8ZOwreEaz/2mQknkjMyUmByqrKf6OyPWekZMKlvtm6thTI4fGTXsOTjOK9RTFNh0jtMGcpcSk1E28EbZGHFipkD3AqBUBdpRNFYM1JpmHebHPztiALGl3egSZpAJ8uUlBvlyJi+TpsC5ABCpevsYAZo+aZobQATQ/vWisVEhn0oTZ7AHeUNmC7Ta6za3FYh9qiw9uvT8ZsGKdGBcjj83N/RZJWAWmmpAWf9xyrPnId4X4uaVp1Mrq4qwWheZ0ZkQZ+mCJnBldNjPN3C5Qo4PPi4IzOAbNnXKv9zpFIOYIYHcHO8ZSSaNpoZtCdT/3AETFk3uTCPyq5n0vgqfxc3io0WmmkYz5en60GMI7oPxQJfwfRDs1s5e/t9CRoQnPD/BUd3dKse0Lbbf+sz4PXMBcTGrBbDDjHvlK03oCe2qPjRE9lEQ1JbEys2T4mOvcwj0ZjJR/1KAuuyyLcLYK+1mLW8/3bvt11ZT1Oaibv80l/ds7BL1Fbfey8bcw9j1Xw9/GExTzy2wPBCEZDnx7C+TVTkNaKHrSxPE3jGn7KnQmYtZC7iJc8U3pjExsBBC5QoXFPN9b1O4T7ZB7+QpAPaoQ0fDFBk0V4N+qCC+Nu+qVja9VD3FVOajyFNDMbQcNOcoZfAXgkhkrXtkEzFAfJaRJTtc3t7cZ7bZCciKYMWHAKsR1ryeys9ieodrFdlpO+YYUSUas9GdoJy8au03TK1AEJlkYzMqTD1i84I/JTGBITixObCY0/6pFKuDFw6qFU0GUcSFzn2ZSJ8tl8HTHcHzvwygBINsDIQctUmSPMA5r78gJfGK4Yw8tPE6VEk++vrUJ6QZ/lyxJeKJl+feRJYa4ntTMFy2D6wSZbWFAKIo6ffKc7KZwzEMwFfX/76hQyUsN+B1fMayWRRD5JF22MJtveRXJck+gYS3/Ig1XxZOBsVEftsnKeGKRSNc5ojY9Sy3IIguW+CgVEZkVUzuOEPO3yh9arDcnkMSmvxKWTZUHICoctrepqNHVnzyXkmcVEDjhMdkFfRa1nGPdROtiHvff96UNN6CQXb+19uQCShEvGAyJz9gW5Lg1mShtm/E3Ypu9yfXrr8BjIAOzYOxp5g20j3YeGnyjAPkSBnJMnTiLsguwDaDw0Kg1UH/K5t+qvduK+//QMv/Ebor9Kau3nJRpRSReS3o54iXnYQX/j1zxsL2xZduasQPFYpezoYAsO7/QLYbwRJmNmH2M5DiUCMb0y1gQMG3831V0hNSumpRFQSxuwDK5fYIbDP86CKN+q3w== X-Microsoft-Antispam-Message-Info: JyfTKA+nmVIBIrE7ZSY53GOpaik3hV+pdDlwi/NMsvftJM4bL8ZzA0lf6uu2aaFG78s2BY52CP/wgupJBdw2cN68H9RhtNX+w43Hs58tZOCiXRXnK7WH3lIyS6z3CtZrzc/1D3+R1hKv6JAtyM+TX4dVnpOuSoOVFbfurhRmS3PLRkCv0wz2JIt0jXC1mVGH X-Microsoft-Exchange-Diagnostics: 1; SN4PR0701MB3646; 6:aGtcvqp9PmTqqzRzdqJBBdRgXmuqzYpN9pa7Qxg51B+xTXIJ43ShtTKqg1rgekh26fCQQi2tCx1wbpLBJHfa7MiZW7v404QbeG0iq5aL7jSSnxVL69LBKIe1VmexwTGKgKZZN8pTVDoNGR+cIRYULK27HAPcmHvJ+9xIbBO7uRz6nkiR/hz1SOi7qdBz7cc+lmvtVrI2MCwm/CYL8ckJVEombnhRqjREIc9edcwbbZavLtQFTtNxHOd59uvDBJ9pxbm526eOZh9Qzvy8TZt+1l7z/TWn0nLrrCC9mzYfIe/ienUr0ObRZKyGXGByMnIj50h1re39FCi6Q6jyhKMoByiOi7y0HM1otQlplayhRbuetwUT0SFuEeEf5ZGMrfQE8DtUfQtNRjPSeMSCSNPoK2R0SaYe6NQEDzVo8GmwDff1hbSrRacyMnQJJyjneUE7ZykAmQL7lQPQYOGW1S+/DA==; 5:+izNDKAPhcV255/MIuKhkbU8o6Z1bn2R3AOdEHSRF0b9bRwG+EqjJFYMHPbsv61x2KqsB8RPkPVXQLoFsPoSWkgEuMsqT90En+YkZq501bLvwyhAAqHMYlr+YH9SXJ8ibxi/VetslaV308m6NRhwDTl1/glYbRSseChPUVFCkTY=; 24:w1bScgq4hlTqRRmT6ekYY5gr8AZJgLzloCUKydr9O5DtUPTredlZDBokvwyfQYB0D4TtViHc/86QOkyicyvq/yJzsqPqTqyTKt5OCjOJPuU= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; SN4PR0701MB3646; 7:Z8Krsk90x0Se7WGwnwcRf8qOlo241W4m6/sl9m03XmiuZ6jBEewSLP9vI2rWNO8bVcWsognvNgOEu2CYzZg9xSucrH0SD1BFV1qIC7LZCTnbQf/qd46JVoCOKemj4kuDVgJWFp6AHugrczgjzk0ceAR4vpUmSx3eApaJLBnrA6NZ2Coq0lAYsL1/1WfQJy9xuQR13Fs6U0a4+ECU3plA5JkKkcMrqX+EJ8mzWKxonZtB0nmUWusKr/Ycv8vOA/Fu X-MS-Office365-Filtering-Correlation-Id: af35ecee-d32c-4f50-6cf1-08d5ba4f42bb X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 May 2018 10:33:10.5523 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: af35ecee-d32c-4f50-6cf1-08d5ba4f42bb X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN4PR0701MB3646 Subject: [dpdk-dev] [PATCH v1 6/6] doc: add ZLIB PMD documentation 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" add zlib pmd feature specification and overview documentation Signed-off-by: Sunila Sahu Signed-off-by: Shally Verma Signed-off-by: Ashish Gupta --- doc/guides/compressdevs/features/zlib.ini | 22 ++++++++++ doc/guides/compressdevs/zlib.rst | 72 +++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+) diff --git a/doc/guides/compressdevs/features/zlib.ini b/doc/guides/compressdevs/features/zlib.ini new file mode 100644 index 0000000..10e758b --- /dev/null +++ b/doc/guides/compressdevs/features/zlib.ini @@ -0,0 +1,22 @@ +; +; Refer to default.ini for the full list of available PMD features. +; +; Supported features of 'ZLIB' compression driver. +; +[Features] +HW Accelerated = +CPU SSE = +CPU AVX = +CPU AVX2 = +CPU AVX512 = +CPU NEON = +Stateful = +By-Pass = +Chained mbufs = +Deflate = Y +LZS = +Adler32 = Y +Crc32 = Y +Adler32&Crc32 = +Fixed = Y +Dynamic = Y diff --git a/doc/guides/compressdevs/zlib.rst b/doc/guides/compressdevs/zlib.rst new file mode 100644 index 0000000..130750b --- /dev/null +++ b/doc/guides/compressdevs/zlib.rst @@ -0,0 +1,72 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Cavium Networks. + +ZLIB Compression Poll Mode Driver +================================== + +The ZLIB PMD (**librte_pmd_zlib**) provides poll mode compression & +decompression driver based on SW zlib library, + +Features +-------- + +ZLIB PMD has support for: + +Compression/Decompression algorithm: + +* DEFLATE + +Huffman code type: + +* FIXED +* DYNAMIC + +Checksum support: + +* Adler32 +* CRC32 + +Window size support: + +* 32K + +Limitations +----------- + +* Chained mbufs are not supported. + +Installation +------------ + +* To build DPDK with ZLIB library, the user is required to download the ``libz`` library. +* Use following command for installation. + +* For Fedora users :: + yum install zlib-devel +* For ubuntu users :: + apt-get install zlib1g-dev + +* Once downloaded, the user needs to build the library. + +* make can be used to install the library on their system, before building DPDK:: + + make + sudo make install + +Initialization +-------------- + +In order to enable this virtual compression PMD, user must: + +* Set ``CONFIG_RTE_LIBRTE_PMD_ZLIB=y`` in config/common_base. + +To use the PMD in an application, user must: + +* Call ``rte_vdev_init("compress_zlib")`` within the application. + +* Use ``--vdev="compress_zlib"`` in the EAL options, which will call ``rte_vdev_init()`` internally. + +The following parameter (optional) can be provided in the previous two calls: + +* ``socket_id:`` Specify the socket where the memory for the device is going to be allocated + (by default, socket_id will be the socket where the core that is creating the PMD is running on).