From patchwork Tue Jul 24 15:05:36 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shally Verma X-Patchwork-Id: 43317 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 935364C57; Tue, 24 Jul 2018 17:06:23 +0200 (CEST) Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-bn3nam01on0061.outbound.protection.outlook.com [104.47.33.61]) by dpdk.org (Postfix) with ESMTP id E38603250 for ; Tue, 24 Jul 2018 17:06:18 +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:X-MS-Exchange-SenderADCheck; bh=HE0wsahM2EaQatCoumGOpRnFv6kBg5z2SRWIqaWR1BE=; b=RnWIpcbMKd5D0rJQWp1yTs9r/ZV3PuAFtb3S67NmrCu8GTnfmAIVdccCetAAApzQtdxxk5u7UqxOg2kV0ZsE6OaSrDofI9vcwVOS7ymbpdA/3nJdj1IeqfFIcd/5EQKSsA36mYsd3HfqTQz7t2S6sdsI53P2peNKt3pdmNJdLpw= 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_GCM_SHA384) id 15.20.973.21; Tue, 24 Jul 2018 15:06:15 +0000 From: Shally Verma To: pablo.de.lara.guarch@intel.com Cc: dev@dpdk.org, pathreya@caviumnetworks.com, mchalla@caviumnetworks.com, Sunila Sahu , Ashish Gupta Date: Tue, 24 Jul 2018 20:35:36 +0530 Message-Id: <1532444736-26801-6-git-send-email-shally.verma@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1532444736-26801-1-git-send-email-shally.verma@caviumnetworks.com> References: <1532444736-26801-1-git-send-email-shally.verma@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: BM1PR0101CA0014.INDPRD01.PROD.OUTLOOK.COM (2603:1096:b00:18::24) To SN4PR0701MB3646.namprd07.prod.outlook.com (2603:10b6:803:4d::12) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 9a4f5d64-9863-458f-b8c9-08d5f17701cf X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(5600073)(711020)(2017052603328)(7153060)(7193020); SRVR:SN4PR0701MB3646; X-Microsoft-Exchange-Diagnostics: 1; SN4PR0701MB3646; 3:wlBEAhpR053IkQDFJj74DjlSVpez2BYPUmiFlb8NxsSanqFyuygOAxx77LQ/2xuTirkhHZ2i1w6GDY6RmlmpQ/8rzGNcYqEmVE7tYL8NzlUvaSLcy5CwyXEORZDfAnNa9SHx8TqyB0HocsKAc8J8OxVSG7mK32T1Uvi9bVvcUnNFprEOxTaoC1f2Mc1WNnEB1Sc/j4L0W5tq7Rjhb8FJMXUN46aTElYpJFoklQe6kBimGDnHd9dtHONf1tLZ6V4v; 25:lfkguZKwBJqZLNLgjoZ4NvhI60lkU7EzrUGZYnkBOD1av747GsTS8tRa6X+3ShxYRR75LDZFCHOrBWp35XOeDFIRLhZkwZb93s8+Zr2nLiRl+ng+abp5NigoYi4Ollgpmnv3HwYkoYDDXZ2nDrNgxA/luiphyqI7NyWEsC6tCT3lULbsNXjdZlQJy4Hbm7I6k91pKtiZTPwECN2RuVD9l+Fm+Z7CNXVZkR82k81zpOEmyylstV5RzROAE07txg0D8N0i+FGTvJOP7rYL/frAjztRbwI6PSw6KkDGOL44mzcqBykn3xRn3d6byoHY7npEAYJ6vN4XLxMH2y2OHHrlZg==; 31:elbeg8ttp1FWEyXNbwQIXw87QN7iXPWICrmx0lpqEsSm7qpJC3lsUZ4aCVDB1PW34W8QFTS7OyH61hud/qU7ZZk9Yk6+6xEeCo5psOu9ExoN0wg3d3SP60QpcXCOLCx1TDmAOKFQcZE4+eYggUrn1it78wCnddLWwsJIXa8nfuV2/o6PD2qHKVxTgx2WlcINgWLAoKrkpyZinEXI/gbWfe2/BKX4q4Qr6FYY96f2l8E= X-MS-TrafficTypeDiagnostic: SN4PR0701MB3646: X-Microsoft-Exchange-Diagnostics: 1; SN4PR0701MB3646; 20:OQN6Vk2S9B8+X7siC1DwbelrOKhrbD1OjqZyu8Y73rxwlxCssTF4Ai7KD2mHrxBEnKKGNrsw8slZkoatMcXqYfqIdjL2zY09QJGUUi7u8W9fmX8egfKUy18PwYzA0As3i4/DonEIOg2ubWx/MXLfvgK2hG8mIq901iMkjwkJwxibGcZTRwoa6qHeIlVdL/d0bVjWYUEDnAc77sS8zX1ZQEQ8YdLlrUvAE/m8rd8A2Hhqn6BO6aJR1ktrXE397YBjv6kAWJs+/UfmWNlGf4xSTHUhTbUq4h1qJV26iVON6FKro+g1l+yDDHTwUz9+jqRK/c7ijoQ9xaJw85uhdypLnGXmVPIFu7Gd+sxHIdCePegwjMqKSg4xhfJCsfCGhFMSgZV+BuaImMfUZhRZOUIfA/VmwSV/ADLiPUvjPNPxObT/4QEJP33ut0Io0ZP7OGNHLE+ahH6+FZCFCRgrOK7XsbiVvC4LxjeeP/rQtn1JUhYiLrtLviB8vgewF6fLQFp5VEEmrHN/7SGxaeE81N5LOrs9Slnx+z00W3zzQkrRvnrApx9qtRPJvXeXcslaUFfsIShWW01vnUmR9JsUC7fx0mHVge0c6J+xqNb1H/hLMz4=; 4:vwmNH79HK8KTVLsf1r3WQdlKqLacvZlgx/sSOIlYd5uYhpjBAvuzcUFJCEbPD2XT1E0X2sStQfRu0GlO9rHnRYnDeILXplC7BXTtvhmawZnlZXLOk+aCooVaoN6JUuzc5OCyym+KuGY+XQsDzzl/AMWCtk1FUhrsnOhS9E7IK3oLLNbNzs1kPBF/E9TPSLVpOSZTss7cJezSxb6bod/yprOplDrNzuYn41wRYHFXYN+PBLibxRQ/jNKsHsVDxXPTNoPQTE4W2vMPUbyzou0hwA== 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)(10201501046)(3231311)(944501410)(52105095)(93006095)(3002001)(149027)(150027)(6041310)(20161123562045)(20161123558120)(20161123564045)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011)(7699016); SRVR:SN4PR0701MB3646; BCL:0; PCL:0; RULEID:; SRVR:SN4PR0701MB3646; X-Forefront-PRVS: 0743E8D0A6 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(396003)(39860400002)(366004)(346002)(136003)(376002)(199004)(189003)(14444005)(26005)(2361001)(6506007)(55236004)(386003)(486006)(2616005)(2906002)(3846002)(36756003)(16526019)(956004)(6116002)(186003)(50226002)(68736007)(5660300001)(11346002)(4326008)(966005)(107886003)(478600001)(53936002)(476003)(52116002)(76176011)(51416003)(446003)(72206003)(48376002)(6666003)(97736004)(25786009)(217873002)(42882007)(305945005)(2351001)(69596002)(54906003)(105586002)(106356001)(44832011)(6486002)(53416004)(66066001)(6512007)(316002)(7736002)(47776003)(8676002)(8936002)(81166006)(6306002)(53376002)(50466002)(16586007)(6916009)(81156014); DIR:OUT; SFP:1101; SCL:1; SRVR:SN4PR0701MB3646; H:hyd1sverma-dt.caveonetworks.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX: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:M+TjWYSLmM2rzpNTylfNMEhnvUdqqwcDq3bN5sI?= vyeiA7aV8lwK0fWL5FzhkFtiPZA8alfBHNkSUf+H399AKPg7UbqET7zwRTcnvdsrOdcGezPzyvDLBDHD5Z1gae/08i9rq19nkD1AcnUH99d3Rc570BQ/9LLB+ivf0Ud561CKfy4qWNeUWlSBm9YDlYQqh5xav0e3AUXyLCycTdiNfpamsyDsbymUmdeKr04hXxhbMwr8Na9H1lg6a0okofSrpGgoTnHCM2xHcTtggTOVbtnwEh5HjmhzUnQt6HhASHxsa09fQqovJOGXngwbcrae8RWJiIbCsPv/cj/I8m1b8Y65lotpJhrZ+EUnoZ8nMHnCa+d8A28wKTzy1JhgPCiWIa7vObeohS7GSxoJT4Ln07/PoPD5Qq5RIMKavRUMw8nUFwCZmrvDjhAK0NQtAwFet+SCzMb3Cf7cHmUE6DGlzdp3Qf3RLdasGfvxsmEQLHNSawPYTH5bQsb5QhNuuSd7mNOR+cBLT1SuT5YsbJ5Ehciew9tZW1uDVomKLp2EYjvvcyui3rc610diA/sgKF+e+v+oqsG1p0xkQMgOelvmNKtrjVl6nVExOZr49SUJzPvrw+8MQYYxEdyYGFlqD+1OY1qxamHmOqWHDJrpKtJIcnsZJUgJKsGWlQ9jdbG4TsZNyz6Z4a3YvHizQoq2qo/RZdgnKNvClQaLvC4maCRzJdawN58pa6YXfui1kfO5RaDYxRCeKRlyykeoGShTpnk65k1bt8/l1jkh8cFo6xIN4iVLIPM7wWh3NQQmWl3Q/VT/PaFc0rGwJSk7h9g1eSFQxmQFN+HMmmqf57JheYaKKbyH9uwG0zvD0LX+9dKvkzewEAWFBwHPAdLuBTONvLmn53Jj8N63/pUpd6Epo2W9WbPTqCCl9sbPdP5rIIz0EXpDx1pRygdgrCADDXyXvS9icwfFgElMoBmhetSiesZI/o/ot2/qfXyV7+W3gmMhx+3pZIX+kgax8Po6o18PX9/ycl9wbUVxf5rNdKWcE5WULkA5S7w03nXP0opCz7JViV1Y7KdORXifh2SzVNbOd3hAG0ep7q9dGnih2CWdUYXKVeouiht84JjJhtuiDaGSWxN1WoP7DuQIxaFWkLSCJTSTQlBbwfpOnhMAopIdC5JX0W163pBhIxXxVLtPC++Praf9U+fj72VdXEO2bQsEFN17yExu/hetRthe7barSpBicEJ04RE2qDJ/2qPlhbJvzYjyA9gjg6cmKTJDHBQMLsrPmE5/GxnAetpAKPgGw9Ub0a363l4MGptGOWNqDXcBtPsAdaCh+IswPaNZmaEhAEtpALXWKA9buozQCvYMjSUn8irhrRtCkaP0vdvlA+URULAOIEGQ7MftRbd/ou49UpFdes2M5222OYFy96FPrG05X43hivjXaj9d0XatQFZW48mo= X-Microsoft-Antispam-Message-Info: Hi432oGg6lo76twEKWREMBoijv+yzZBy5wXAGSRh1MHfdtpYvXtxwdyD5viL9jJWiIYFxfeE80+rT7Yp9Ky5XguYa2FTFIWKfMTQzXZaSdi0oNvMtdJjmXbQyL1bRD0cgpHguUFLHPLJf2kxtt8cgD4PgafmHozZj0Jed6f8l/lexiE6AW6LRBXbqvZq0YplUapzSk+Yk/9SLJnx56GILZE+yRt+svloBtTAe0WnsdHVrD+GQMtlWU0U2/Qj05hBTaomQMj2W/7jqeQEkHl1J6seDMIyLrnh0M8WKa7AyKs6fZV/K+Fdy5pLPu+EnkyRcUc7zK51ZAjgFVKX7IMTcgtBhjOXSDcsgfQp4VY4zGg= X-Microsoft-Exchange-Diagnostics: 1; SN4PR0701MB3646; 6:eGcekjbs909yPpRrUwW5dXV6+uoPWhljjpD0LkZlg216e8MUd4hFknlH74nSe/bMBKWiTO827g+GRnWyZv7HX3SUamIBIZIsz165o+VXVj06by4daI6/XME1HfkYrZvfqPvifyXkpWCcPaOOuFKZwL+HQ2RTkAiCgasILp81XdYK6ONOwQm8+gKMhQbXbf9itFnewBJigZJl4WcVh0vkWEWBWjPAEDlhsP3p72tyVNXcJrhGqVRXioDuOLLu9CzkwlR27sXg0OiTQ5u7nAEtpKLUWpn31cs32qO84noC6uIRkSR9P7BEAuVxPaOFpgT//PvafoZNSwkaHfHJXbSNxn8ZMdunGw4eJ9yitqpegUEnOU1+MXYBCFLhsg7dzAOzXq94ei505Rn1WzqBhG7yxmT8tE676gPXYc3LXHXueKyQQi/Fj3s6yXgz8qp3Zz344+94S5/MizS0xHJ8MPVN2Q==; 5:JCiUEWvlGnFam8sFBmBZL/Z+OoK7dvoR7QuiUKCbyo2XfUOlUluSsNoFN8Hd2k/NJaTaxVe9hXSlRj6UNhvaCOUoKOdD34hvaZcGCuVnX7EmrxCbiaArxZ/Kbft4GfahWiB8soPn9Cxgyi0wosSE7tJ1IuTX75DjSp/tVulghVY=; 7:IfK5FyRwBI4Cy+0d4ogArMU873ZBTlmXYnsCGL1Zn7xJOiBd0ImoHJLJON47htYYDUB+HevTyaIlf/i2gGOMABkPRMYbarRewWg5E1u4GpIpIrKXkd59L3Y/I30V0P3hFGeqbO67I9D18PHFd6jmFLp2a5821qn3Cr95DwtRegSnUrCQkvA5n6R9erMhWyaj9AVc378rEXgPSaC5uvZ5xMPZGxnrTFTLiTe+n47gcUQIn4Q9ScHC4lcMsluo8zte SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Jul 2018 15:06:15.4600 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 9a4f5d64-9863-458f-b8c9-08d5f17701cf 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 v5 5/5] doc: add ZLIB PMD guide 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 support and user guide with build and run instructions Signed-off-by: Sunila Sahu Signed-off-by: Shally Verma Signed-off-by: Ashish Gupta --- MAINTAINERS | 2 + doc/guides/compressdevs/features/zlib.ini | 10 +++++ doc/guides/compressdevs/index.rst | 1 + doc/guides/compressdevs/zlib.rst | 69 +++++++++++++++++++++++++++++++ 4 files changed, 82 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index ca27c6f..7e3c450 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -875,6 +875,8 @@ F: drivers/common/qat/ ZLIB M: Sunila Sahu F: drivers/compress/zlib/ +F: doc/guides/compressdevs/zlib.rst +F: doc/guides/compressdevs/features/zlib.ini Eventdev Drivers ---------------- diff --git a/doc/guides/compressdevs/features/zlib.ini b/doc/guides/compressdevs/features/zlib.ini new file mode 100644 index 0000000..58a4ee3 --- /dev/null +++ b/doc/guides/compressdevs/features/zlib.ini @@ -0,0 +1,10 @@ +; +; Refer to default.ini for the full list of available PMD features. +; +; Supported features of 'ZLIB' compression driver. +; +[Features] +Pass-through = Y +Deflate = Y +Fixed = Y +Dynamic = Y diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst index 4228768..6ba6641 100644 --- a/doc/guides/compressdevs/index.rst +++ b/doc/guides/compressdevs/index.rst @@ -12,3 +12,4 @@ Compression Device Drivers overview isal qat_comp + zlib diff --git a/doc/guides/compressdevs/zlib.rst b/doc/guides/compressdevs/zlib.rst new file mode 100644 index 0000000..986c59d --- /dev/null +++ b/doc/guides/compressdevs/zlib.rst @@ -0,0 +1,69 @@ +.. 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 + +Window size support: + +* Min - 256 bytes +* Max - 32K + +Limitations +----------- + +* Scatter-Gather and Stateful 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:: + sudo yum install zlib-devel +* For Ubuntu users:: + sudo apt-get install zlib1g-dev + +* Once downloaded, the user needs to build the library. + +* To build from sources + download zlib sources from http://zlib.net/ and do following 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).