From patchwork Mon Jul 2 16:57:11 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shally Verma X-Patchwork-Id: 42119 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 D3B361B5A9; Mon, 2 Jul 2018 18:58:08 +0200 (CEST) Received: from NAM01-BY2-obe.outbound.protection.outlook.com (mail-by2nam01on0056.outbound.protection.outlook.com [104.47.34.56]) by dpdk.org (Postfix) with ESMTP id 5F2BC1B59B for ; Mon, 2 Jul 2018 18:58:07 +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=tfGNxMmkaUR6ETQ07OtlupqlYX1h6CyrgsYhATfiuP0=; b=Zr3hY8hv92ZV5VKVoXdnk7x/H12uWbW4SR7VW2qhO8tfiaBCgPcFSiIZ5Z01gnCSPLH77nTnR2PzPDr4BwkE6q6HhPgXSi7Opy/sSJHoevQ6t8UwYNRlZTQOw3cYz7LEMevXpEnJA9VL/9ry+L+calJ68W4nqMqmD/Ixw5Q/xjg= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; Received: from hyd1sverma-dt.caveonetworks.com (115.113.156.2) by CY4PR0701MB3635.namprd07.prod.outlook.com (2603:10b6:910:93::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.906.23; Mon, 2 Jul 2018 16:58:04 +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: Mon, 2 Jul 2018 22:27:11 +0530 Message-Id: <1530550631-22841-6-git-send-email-shally.verma@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1530550631-22841-1-git-send-email-shally.verma@caviumnetworks.com> References: <1530550631-22841-1-git-send-email-shally.verma@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: MA1PR01CA0081.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00::21) To CY4PR0701MB3635.namprd07.prod.outlook.com (2603:10b6:910:93::10) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 933f7ddd-85b7-49ef-93c8-08d5e03cfb53 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(5600053)(711020)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(2017052603328)(7153060)(7193020); SRVR:CY4PR0701MB3635; X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3635; 3:MTOhT1G/BIA0yG/cXBnpkdbOx5jSTLtJmyjmuSxiouMpmSYBKvvnR3+M7syk5jYgUwfZr0LTnDGWfu3pXzGD5eKJ835ptx87eBYr/M7Cv4SfpSn7jr4BJYkb88CfiRAhbwL6ZJ/BskC0jXCAjBaqegWDh0Th+XItoaPzI4C7kSLMcwT+ShTF16M+hMM0/zHIr31r0tRmyNP0gAHJ1U0mmw7ztforhWsZATaLYROoTQZOP3f6NDWnGO+SkIWLP9mr; 25:MVivtBWJ08EwJlj+3lqngd61bZjUqUF4xZ4yJknm6zWGw/o4Cw0oqKL+GLLMh1RhqIFTa2tAoBYV7aWpv46U42qb8GiKPVyPWc3BSG7X3uRVvnlwzmlidCCIXSJgRfpdmpY/natwMVNewyE5ppEoDTMNLqn6sEYmpVcLUemwvaMtiMg28PpMRfZsDA2spIg0GWpcsZc19F+RRt+eIfXDi3jfwc+YhnRNLjkIWkUThgNTYZaYEQOfJ3e6Nc1gbdcO1HvxBWqVoWpbxAdtW8qdYV85tOkEaHOoshpCl2nRP/N4xhyLMa8V3ZtWVWBi/h6gNMHNJ2tx8YiiwIjwJyUQtg==; 31:S/TpDftQBcRLOMJmmqgpG3Vf/sLaUzYb6ElMATRHd5/uB/ZjB9d2UNvNR79huE7C+dfPg8m4udLz9RsSGGxB1PZv2vtA/ol3u+wIk+yhNQ53DnLsnCMU5GQ7yp0S+b8zSX/iSQt6UzPG3ShGSRWB44TxK+2KlvBz/UvvMH9lPprPuzvnBQFVcoyDb2t8UAE6ajkH9PqGQpIZ90UdZqPjtzB99J2o8EeWGhVuv1g6GF0= X-MS-TrafficTypeDiagnostic: CY4PR0701MB3635: X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3635; 20:0wfTK111j3KGHKq6sGpSUL6EQi+u78rIppkSnDcUNO5kKAwTFo84Nrip/v7yGkQQ/PZgelRJ3BN//BbQEpKKqs+4Evp9YolLOyP1u2JZWTlSmypsHxMcRMh6uJY/yDJhiaTgS3JmLPgkACzam+8deHZX65SbH5yEV+MMtCd9RTj2EOjs9+zqhba4OxzFeg+dRZEWls6ZhNiGewSVY06sEpaeQD9WjsJa76piwnho4Jefv0YtGsFInK2z9mgbIOUW5S5Hb3herlx07P2nbfbwYGcv3iporpYitvzzfq+uCLU9ZLUEAsKN/7IL3HGk8GupuMkcj0lHg1okhQ2T+IIHG0v9/JZ/FHzTM0a4RQJIXR9FsWmiOKo0k+57gRud4YoBzwwtWrMlSvjeLBvgvtICs2COWccCM2o0a2fxkahqD7KsYUY0SUkfnqsaAUUjcW7wwBHIulK2uezRwQSiloWLFjcKtqMNQQN41D+FarN9oCpmVzPECac3y/iPk+o+ib2UWCOclKbv3cEWoDY64jxM3gur6e1kFnSOVHDjaClyX7bb73nPjBCuUau5ibD+nWtjhlH8/OjTWa9m8j4YlLBF1W2wpDWSLQ3gdbDhOHvd3Ew=; 4:wGSbx5WhSndZtxISQZxCc5ynPe/tn8EjEv+6UtZa9z9fizdJfpVltUkR9qTZVbk4AU6uPOkte7tjOXyPBNr8QbI8DAz2kQwhEjSLRsV/YEfIAt71hnnkDuxUGAelvc7Psi5Dsty29Uz7xn28DElQDsqLKD5ypRUb//6cD0VOx5Rn8qT1KGZdSkJUM2Xw/LQ14adtyNfX1Vq3x3RcQ+4nORUaKCfA28VmqDbBPg+ACRXYVqfNIhjI/OQgnQzhw+WmG2C8YCelBND0+a5pIl5JXA== 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)(8121501046)(5005006)(93006095)(3231254)(944501410)(52105095)(10201501046)(3002001)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(20161123564045)(20161123562045)(20161123558120)(6072148)(201708071742011)(7699016); SRVR:CY4PR0701MB3635; BCL:0; PCL:0; RULEID:; SRVR:CY4PR0701MB3635; X-Forefront-PRVS: 07215D0470 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(346002)(396003)(39860400002)(376002)(366004)(136003)(199004)(189003)(478600001)(72206003)(106356001)(6486002)(42882007)(4326008)(53936002)(107886003)(25786009)(476003)(26005)(8936002)(16526019)(6666003)(8676002)(55236004)(2616005)(11346002)(6512007)(51416003)(76176011)(186003)(6506007)(446003)(956004)(52116002)(6916009)(81166006)(7736002)(81156014)(44832011)(575784001)(486006)(305945005)(386003)(66066001)(16586007)(47776003)(316002)(50226002)(54906003)(5660300001)(3846002)(6116002)(14444005)(50466002)(48376002)(68736007)(2906002)(2351001)(2361001)(97736004)(105586002)(53416004)(36756003)(69596002)(217873001); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR0701MB3635; 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; CY4PR0701MB3635; 23:8RHAMRbQyKAAeub6Vmj/1awdHwt0Loy/L7E2qGk?= Ne+ejxSbEVjl6sCmgcRiWDNFTjejgoOCBpSSxymQHod3wI5yJlN5SK4R+Z69/zkIXzYjunUVkfGpx03fWJj73QgLrwgEb0FEozX1aSZrtDL+siGKV2wCmCI7qClJ2dXaUJLrC8+0F758168D2bxeRUGleh1vooL2fVILpbHTTuKrJacC46QWdaN56TLk7CslhgLIYz7PVvlWOKhzVwNgBX4aGdalwEGr/qCqYCrFcdlVR8Xoty5xjJduD7GCTw0Bh27byEk1ji5AQ2seVwm2NjGGcZ+dkopwn3cSojCLkwG7aEeluSxjMuzEmK3Uk2bQq/2nnQ5HA2E/BdhvpNfBvCClmMbRzYS+Y68fGAODtnrQdMBVOUmxXK/J/YbqY3t2h5iwe2MVBEk5zFT/hgWFrGGKwQ2xwZa/70M76lJtLIlFVwWUFaemEcvj9BS7ymUz/YD7pOrr2sZLQmVIuCdCmbteCSenTHdxGq9lgfxG2YWg5pdQ44QhK2KL3pE7zTedmXEC/PQq6rTRNambGHTQ9HJ1mObOTpd2GZ7N7d2gU2vIQoVLFiFI1U7b5kQvd6r3iGyBujK/5VfD7NSvLVuJj6cAnaTQgAnl8+EygLuMCAXirswS4EtCZQ3HlCkb7+9zAjiaunUHog9bHpfZan6hyyN6qLce4laumwiB0DzC61Z0AoqK6rhud8hRtJGWG0KjrTDRdFs8leWa5KrHEmKKTBnAwgJJ8Z4AGTeRd2L/rpaF+m7BRNRzSgyx0kFBvPkP56PeEVLJ/1+WEUAI/QzMqd6gzO1VAIPHMpdP+OcOymFIcNdTyT6BnYy8ww4KG+McPTLOeJ9gEpC69iPWThcJu9CP0WzXjj5Lak1sY5oQTBPS1UURIR1qGKlNfC7cbaSUyfQrxlLtjOlAeQ6zWGg6aIZSycZCQdEnR+Moa8suGqjGYTnx18kYljDu2wlyqt9E/A29rLXuOPQJXoGsqAWS79Eo9K+iTDDELGuc9xzgfTs/uwdm0sA86CDCBGgRCPVSSUGxM+dkrWJKJycska4LTkUQoMYGdJp88wvn1u654t7SF2Gl5SbxBU6VuRAVZeleGryckt6TCGSSie5WWSWmJmvuLl+JLsgLIYzRZyrz0zG8jUTm7NbHf6obtE3tuzFYFJ4xbJXeuaUUMvWY6+HFiNbZbf0GpR20U4emDHqDTqlEb77QdY7OBsXdHK2DGipbUq/He7r97rWEQEK01rNN7SvuOTkIzHBc+EdA0rmgabCsejIO4mWWses+M/GUzKe5tzymAZZW1sLi3lVd6kJD5PrPI38RNghHkBSEQV4BGIInYWwOJPf5QZ7Xt4B2k8Xto0Dhbr0c+i3AtZtz6sFnNcqIYpVWM+UOC/xcfixj8vbuhSg== X-Microsoft-Antispam-Message-Info: KpTgQ4k6PLqVQDlPW3eWXx7WCHzkrcpZvb/oH9sLzb5PmV881OBW/6IWymuigJ6mXRoASUo0NE28DXsxOYY+IGbIdvE32UAYJRubqJasXn1RlCQsVPVGW9mlbReo87HqAve+6Kbbc5e7iKEPjb7xmurTymT+tWsobex19+JC3cbiEWFv+Nuv4ljQpAJ5YW8fYpY+DItNO7ejSATblZD/7yOjvrkjXOSDedA4VXTahw51Pqz8MuugbDhvsoXbT8kGsOkDIgveK2SPX3QqcBfTWrDjgYt1k3bvV6ullMDQlIQ2f27CLqViIV1hW12cIVj1qs5ybjaHNnMW11BeeBeFO8jhEXJd14/LaEVF+qMlapc= X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3635; 6:Mm+/GoxBLTeSAUyw0o0H++xX0qvZj/7xMFDkbVupU1e8mNx70xGtIH8d2AtgWyiNoxo8U4lNvbMo9XL3EjqYWcT51RTz7lSGNdrzGh0xbWmfQJVJfrbJAo318ngkrqseRDi8ZrBSa0vS2a3Ygil50EvncGZijKqP/Py8LYIKpS0lIzwczvu64TQHck28QiBJHibKFlufOjQpWTMt2OxnjiN52mKG9+RnIOGSsT51uh0zCKmzRoLV0pw2XLZ59uZIXcUkgF5ZIEtrj0BEF5XHCgMUqbUpeZb3pAU1zGf7LaUFMEXYK7MKn1AAJkv5n3tpOMtYeXoC6ywadlzR6bgyrf1zn/cr7DOWA8KDVrCElT+gg9SLSvjevrTJmc4quCXN4569iOmFcK0J18gKMFHiXkDZ1tb2bS8lhP1+8SMzl/gGjsdmuuxEoCTSsiS/cKWD0xDStqb+gi9kAE1VOJF/1Q==; 5:r39UaI78qg3WLO4sGPnLJ9gkt40mOv9FfvlUMGGYhi22DM+mRG4yvf3oWvK1aGaCmV/FykYJvKfsuNUJraehX+CrpZK6rmQfcJmnj2cq1xwi6n83QY+HAmw8Un//eF/bJ4Ujy1GJgxng4xWJ+uh0yJHYF0wZIWQi9pQoFKUgSpQ=; 24:YgB2RGXummI2sA4XNFGDR/CdSsA7Y0uv316nxOHA2Ym2IV/CeZsftnxbz222Nc2GbjNQhmnMhJsn02V6Qk2jfo0t+y/yyytZlMHotY560dg= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3635; 7:QlTXYtPhmd6KxCmmtkum8vjCTr5NZCZPRikb8X+NBWJZhHHUyGcS6hqeqcOM9YThP7f38CuZp7C5XgdFncxi3EzUIOD79GzMoi4jtGvgSoT6zBiXaIqSC39spwLrs2K72EYrkKWCccgixULzEUJp1FMgzN6YRkjz+jfkofmF7j04GZ7sDOfINwId5hOOIUxoUWDF+QBCm1bmDY7vIUeONATIBP/havZwcvR1Q1mWlG+KTcIsURjeXW4ONfIlcb7g X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 02 Jul 2018 16:58:04.1957 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 933f7ddd-85b7-49ef-93c8-08d5e03cfb53 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR0701MB3635 Subject: [dpdk-dev] [PATCH v2 5/5] 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 --- MAINTAINERS | 2 + doc/guides/compressdevs/features/zlib.ini | 22 ++++++++++ doc/guides/compressdevs/zlib.rst | 68 +++++++++++++++++++++++++++++++ 3 files changed, 92 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 448bbe1..1c217b0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -854,6 +854,8 @@ F: doc/guides/compressdevs/features/isal.ini 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..bdc0fc4 --- /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 = +Crc32 = +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..7dd5c74 --- /dev/null +++ b/doc/guides/compressdevs/zlib.rst @@ -0,0 +1,68 @@ +.. 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 +----------- + +* 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).