From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-DM3-obe.outbound.protection.outlook.com (mail-dm3nam03on0055.outbound.protection.outlook.com [104.47.41.55]) by dpdk.org (Postfix) with ESMTP id 4751C4C91; Tue, 30 Oct 2018 14:59:36 +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=0g5ciPGUcZz6pdRwzf+F8ynBJg9ZrNxtrVRiZE9gUdQ=; b=GlMi+4MfwCT8N+rmQLcpOYUzROJ6ZdhUFfLSWDNpH+RvTlV/Jsshj+J0BPQBvLuW+RnXS5BOURJuN1SPc1S7Xvw0uXRq/qnwz23LLLH3AjldVJfbesWeiZmGCm5iK9Hro88Rq+rKLzPidYVy11hlcAjnd8XdPw++PSq+LcxDdAc= Received: from SN6PR07MB5152.namprd07.prod.outlook.com (52.135.101.33) by SN6PR07MB5054.namprd07.prod.outlook.com (52.135.121.84) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1273.26; Tue, 30 Oct 2018 13:59:34 +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.1273.027; Tue, 30 Oct 2018 13:59:34 +0000 From: "Verma, Shally" To: Fiona Trahe , "dev@dpdk.org" CC: "thomas@monjalon.net" , "akhil.goyal@nxp.com" , "tomaszx.jozwiak@intel.com" , "lee.daly@intel.com" , "sabyasg@hpe.com" , "stable@dpdk.org" Thread-Topic: [PATCH] lib/compressdev: clarify usage of op structure Thread-Index: AQHUbYn5NkpSdR8apE+TIbRipdSGfqU31lrw Date: Tue, 30 Oct 2018 13:59:34 +0000 Message-ID: References: <1540599234-17310-1-git-send-email-fiona.trahe@intel.com> In-Reply-To: <1540599234-17310-1-git-send-email-fiona.trahe@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.2] x-ms-publictraffictype: Email x-microsoft-exchange-diagnostics: 1; SN6PR07MB5054; 6:7TjKnXOVpthidlLzQemcK0Cq1jQFne/F+1SWKIfOVpbvo3H1y77fOL8sPGbPFzdB0hOa7gOchHGugR3r+S3cVGkk7hyJeU/ZZwIcicsmsOKCBbz+7iMAYbKDLlxGe0ciUSSVf8239k1zVO3QmPN4/oHExfGjE0W2P52nTzgrGC6m7JIOmy8zhwozP03f+nF5FyLr49iausKu4vGyqMV88eSAO9UytJD9AYzszMg4ZCH5aD2beXLGb8ryqYURJBOzSYuzLXytj/KZG8P0B8/fQbqZDtd9KfH7XemiNNpI/PYZ8PWbsEM4mQs9Sf96N07rESBT/U4i5Jex8/FlnzMfCzhDdQNEbManlwKxAmrE0QDqxEYNn1QaAGVTvctAwjmEZqpTsLtrOstNIoa9mwQSZwroSMt9Y4xR4/68/skOA2enJfBLPzJ5toDhzCeULrdbr4AyglxGQpqL8cKfl/hUvg==; 5:XsM7Xtyn9v4KKpSTG02BoTwpBzE13IxGJCFOGBGUHsII9sylwxXfj1d9fRbfOXbGxvX6JR8sZsmH8m1cbG0JLlNBFyOi+4CJ3biY+IA/KAB/0u+nFXLQlZ0zzpq6brIaH8/CASJCl8L2i+8lh+iuBEsiUaeYN3WXgr1mtwsNEXc=; 7:Om8bkfDqkufRBSd4y6dF/NvCBFKpwNXnGbaUasFpoMlQYIK0eZ9G3r9oAqM4avVfwkNdSoBi0IgvRM4kySVJBExTsZkILRpIx51zlMNVr2QRRq1LAZDYnCpOVBJUMWbQGTpkBX0GDNhS5ko297+rUA== x-ms-exchange-antispam-srfa-diagnostics: SOS; x-ms-office365-filtering-correlation-id: 8852f24e-9d01-42fa-59df-08d63e6fec0d x-microsoft-antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(2017052603328)(7153060)(7193020); SRVR:SN6PR07MB5054; x-ms-traffictypediagnostic: SN6PR07MB5054: x-microsoft-antispam-prvs: x-exchange-antispam-report-test: UriScan:(185117386973197)(228905959029699)(222181515654134)(227479698468861); x-ms-exchange-senderadcheck: 1 x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(93006095)(93001095)(10201501046)(3002001)(3231382)(944501410)(52105095)(148016)(149066)(150057)(6041310)(20161123558120)(20161123564045)(20161123560045)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(201708071742011)(7699051)(76991095); SRVR:SN6PR07MB5054; BCL:0; PCL:0; RULEID:; SRVR:SN6PR07MB5054; x-forefront-prvs: 08417837C5 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(366004)(396003)(136003)(39860400002)(346002)(376002)(13464003)(189003)(199004)(71200400001)(186003)(105586002)(55016002)(5024004)(66066001)(256004)(26005)(106356001)(33656002)(316002)(102836004)(4326008)(5250100002)(2501003)(76176011)(7696005)(6436002)(110136005)(6506007)(2906002)(54906003)(14454004)(55236004)(72206003)(68736007)(81166006)(53936002)(71190400001)(8676002)(3846002)(486006)(9686003)(8936002)(25786009)(6246003)(99286004)(74316002)(86362001)(6116002)(7736002)(81156014)(476003)(97736004)(11346002)(478600001)(5660300001)(229853002)(446003)(2900100001)(305945005); DIR:OUT; SFP:1101; SCL:1; SRVR:SN6PR07MB5054; 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: VMdRO7wj2c2HwHNnYcEiaVQZbzZEjt3wK+Kd8m7THJiR7oFtvNrEcvnVyxfQnmErV8Zs/OXcJYAvD6T4Wpa1WQlF2b2totS+7Vl7g03cAtmEBPybirX46D7VyGA2k8paRxPc8FE9YQ7IEYa+nzpFjRoPGySRJM9Yo5ABWf7QL4cMMzOVMtFfxEcf+4Y14bDpJ4DqHLJXEEl5Rw5BL9nwXg4RiisU+mcri05ksZ4MFxeZEBQtuXQySxWpTmJDBeWvBv2famK/clCKMdoOBqfhl5fCKs6MP6Y1pfumWi9lS5YxNrpNaE8yEC2pvEE5PBXs6S6h+tNdvEcnHVmMz2XMYk7UZ3SrTUdkCbMBUIvjOuM= 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: 8852f24e-9d01-42fa-59df-08d63e6fec0d X-MS-Exchange-CrossTenant-originalarrivaltime: 30 Oct 2018 13:59:34.0692 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN6PR07MB5054 Subject: Re: [dpdk-dev] [PATCH] lib/compressdev: clarify usage of op structure 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: Tue, 30 Oct 2018 13:59:36 -0000 >-----Original Message----- >From: Fiona Trahe >Sent: 27 October 2018 05:44 >To: dev@dpdk.org >Cc: thomas@monjalon.net; akhil.goyal@nxp.com; tomaszx.jozwiak@intel.com; l= ee.daly@intel.com; sabyasg@hpe.com; Verma, Shally >; Fiona Trahe ; stable@dpd= k.org >Subject: [PATCH] lib/compressdev: clarify usage of op structure > >External Email > >Add note on usage of op structure and when it can be >accessed and freed. > >Fixes: 63f4bfd5328b ("compressdev: add enqueue/dequeue functions") >Cc: stable@dpdk.org > >Signed-off-by: Fiona Trahe >--- > lib/librte_compressdev/rte_compressdev.h | 7 +++++++ > 1 file changed, 7 insertions(+) > >diff --git a/lib/librte_compressdev/rte_compressdev.h b/lib/librte_compres= sdev/rte_compressdev.h >index 5b4fca4..7b68170 100644 >--- a/lib/librte_compressdev/rte_compressdev.h >+++ b/lib/librte_compressdev/rte_compressdev.h >@@ -408,6 +408,13 @@ rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_= t qp_id, > * @note All compression operations are Out-of-place (OOP) operations, > * as the size of the output data is different to the size of the input d= ata. > * >+ * @note The rte_comp_op contains both input and output parameters and is= the >+ * vehicle for the application to pass data into and out of the PMD. Whil= e an >+ * op is inflight, i.e. once it has been enqueued, the private_xform or s= tream >+ * attached to it and any mbufs or memory referenced by it should not be = altered >+ * or freed by the application. The PMD may use or change some of this da= ta at >+ * any time until it has been returned in a dequeue operation. >+ * > * @note The flush flag only applies to operations which return SUCCESS. > * In OUT_OF_SPACE cases whether STATEFUL or STATELESS, data in dest buff= er > * is as if flush flag was FLUSH_NONE. >-- >2.7.4 Acked-by: Shally Verma