[dpdk-stable] patch 'compressdev: clarify usage of op structure' has been queued to stable release 18.08.1

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 18.08.1

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 11/29/18. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the patch applied
to the branch. If the code is different (ie: not only metadata diffs), due for example to
a change in context or macro names, please double check it.

Thanks.

Kevin Traynor

---
>From a83d3c6cfb66a89e3afae710c87c0074b00e187b Mon Sep 17 00:00:00 2001
From: Fiona Trahe <fiona.trahe at intel.com>
Date: Sat, 27 Oct 2018 01:13:54 +0100
Subject: [PATCH] compressdev: clarify usage of op structure

[ upstream commit 1fca14d7dd4fed32e67cb2622546552c57b00c38 ]

Add note on usage of op structure and when it can be
accessed and freed.

Fixes: 63f4bfd5328b ("compressdev: add enqueue/dequeue functions")

Signed-off-by: Fiona Trahe <fiona.trahe at intel.com>
Acked-by: Shally Verma <shally.verma at caviumnetworks.com>
---
 lib/librte_compressdev/rte_compressdev.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/librte_compressdev/rte_compressdev.h b/lib/librte_compressdev/rte_compressdev.h
index 5b4fca4dc..7b68170a5 100644
--- a/lib/librte_compressdev/rte_compressdev.h
+++ b/lib/librte_compressdev/rte_compressdev.h
@@ -409,4 +409,11 @@ rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
  * as the size of the output data is different to the size of the input data.
  *
+ * @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. While an
+ * op is inflight, i.e. once it has been enqueued, the private_xform or stream
+ * 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 data 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 buffer
-- 
2.19.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2018-11-23 10:22:54.859824048 +0000
+++ 0023-compressdev-clarify-usage-of-op-structure.patch	2018-11-23 10:22:54.000000000 +0000
@@ -1,13 +1,14 @@
-From 1fca14d7dd4fed32e67cb2622546552c57b00c38 Mon Sep 17 00:00:00 2001
+From a83d3c6cfb66a89e3afae710c87c0074b00e187b Mon Sep 17 00:00:00 2001
 From: Fiona Trahe <fiona.trahe at intel.com>
 Date: Sat, 27 Oct 2018 01:13:54 +0100
 Subject: [PATCH] compressdev: clarify usage of op structure
 
+[ upstream commit 1fca14d7dd4fed32e67cb2622546552c57b00c38 ]
+
 Add note on usage of op structure and when it can be
 accessed and freed.
 
 Fixes: 63f4bfd5328b ("compressdev: add enqueue/dequeue functions")
-Cc: stable at dpdk.org
 
 Signed-off-by: Fiona Trahe <fiona.trahe at intel.com>
 Acked-by: Shally Verma <shally.verma at caviumnetworks.com>