DPDK patches and discussions
 help / color / mirror / Atom feed
From: Fiona Trahe <fiona.trahe@intel.com>
To: dev@dpdk.org
Cc: fiona.trahe@intel.com, shallyv@marvell.com, ssahu@marvell.com,
	lee.daly@intel.com, ashishg@marvell.com, akhil.goyal@nxp.com,
	tomaszx.jozwiak@intel.com, stable@dpdk.org
Subject: [dpdk-dev] [PATCH v3] doc/compress: clarify error handling on data-plane
Date: Wed, 15 May 2019 12:16:07 +0100	[thread overview]
Message-ID: <1557918967-6869-1-git-send-email-fiona.trahe@intel.com> (raw)
In-Reply-To: <1554821747-27868-1-git-send-email-fiona.trahe@intel.com>

Fixed some typos and clarified how errors on ops which
fail to get submitted on the enqueue API should be handled.

Fixes: a584d3bea902 ("doc: add compressdev library guide")
cc: stable@dpdk.org

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
v3 changes:
 - change proposal so appl must check status of op_enqueued+1 if
   all ops are not enqueued.
v2 changes:
 - changed "0 or undefined" to just "undefined" as 0 is superfluous.

 doc/guides/prog_guide/compressdev.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/doc/guides/prog_guide/compressdev.rst b/doc/guides/prog_guide/compressdev.rst
index a06c835a0..bd9bebce6 100644
--- a/doc/guides/prog_guide/compressdev.rst
+++ b/doc/guides/prog_guide/compressdev.rst
@@ -201,7 +201,7 @@ for stateful processing of ops.
 Operation Status
 ~~~~~~~~~~~~~~~~
 Each operation carries a status information updated by PMD after it is processed.
-following are currently supported status:
+Following are currently supported:
 
 - RTE_COMP_OP_STATUS_SUCCESS,
     Operation is successfully completed
@@ -227,14 +227,24 @@ following are currently supported status:
     is not an error case. Output data up to op.produced can be used and
     next op in the stream should continue on from op.consumed+1.
 
+Operation status after enqueue / dequeue
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Some of the above values may arise in the op after an
+``rte_compressdev_enqueue_burst()``. If number ops enqueued < number ops requested then
+the app should check the op.status of nb_enqd+1. If status is RTE_COMP_OP_STATUS_NOT_PROCESSED,
+it likely indicates a full-queue case for a hardware device and a retry after dequeuing some ops is likely
+to be successful. If the op holds any other status, e.g. RTE_COMP_OP_STATUS_INVALID_ARGS, a retry with
+the same op is unlikely to be successful.
+
+
 Produced, Consumed And Operation Status
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - If status is RTE_COMP_OP_STATUS_SUCCESS,
     consumed = amount of data read from input buffer, and
     produced = amount of data written in destination buffer
-- If status is RTE_COMP_OP_STATUS_FAILURE,
-    consumed = produced = 0 or undefined
+- If status is RTE_COMP_OP_STATUS_ERROR,
+    consumed = produced = undefined
 - If status is RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED,
     consumed = 0 and
     produced = usually 0, but in decompression cases a PMD may return > 0
-- 
2.13.6

  parent reply	other threads:[~2019-05-15 11:16 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-08 16:14 [dpdk-dev] [PATCH] " Fiona Trahe
2019-04-08 16:14 ` Fiona Trahe
2019-04-09 14:55 ` [dpdk-dev] [PATCH v2] " Fiona Trahe
2019-04-09 14:55   ` Fiona Trahe
2019-04-18 12:12   ` Shally Verma
2019-04-18 12:12     ` Shally Verma
2019-04-30 16:33     ` Trahe, Fiona
2019-04-30 16:33       ` Trahe, Fiona
2019-05-07 17:14       ` Shally Verma
2019-05-07 17:14         ` Shally Verma
2019-05-07 18:24         ` Trahe, Fiona
2019-05-07 18:24           ` Trahe, Fiona
2019-05-08 12:41           ` Shally Verma
2019-05-08 12:41             ` Shally Verma
2019-05-08 14:00             ` Trahe, Fiona
2019-05-08 14:00               ` Trahe, Fiona
2019-05-09  8:58               ` Akhil Goyal
2019-05-09  8:58                 ` Akhil Goyal
2019-05-09 10:44   ` Shally Verma
2019-05-09 10:44     ` Shally Verma
2019-05-14 15:29     ` Trahe, Fiona
2019-05-14 15:29       ` Trahe, Fiona
2019-05-14 15:37       ` Shally Verma
2019-05-14 15:37         ` Shally Verma
2019-05-15 11:16   ` Fiona Trahe [this message]
2019-05-15 11:16     ` [dpdk-dev] [PATCH v3] " Fiona Trahe
2019-05-15 11:43     ` Jozwiak, TomaszX
2019-05-15 11:43       ` Jozwiak, TomaszX
2019-05-15 12:03     ` Shally Verma
2019-05-15 12:03       ` Shally Verma
2019-06-19 14:57       ` Akhil Goyal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1557918967-6869-1-git-send-email-fiona.trahe@intel.com \
    --to=fiona.trahe@intel.com \
    --cc=akhil.goyal@nxp.com \
    --cc=ashishg@marvell.com \
    --cc=dev@dpdk.org \
    --cc=lee.daly@intel.com \
    --cc=shallyv@marvell.com \
    --cc=ssahu@marvell.com \
    --cc=stable@dpdk.org \
    --cc=tomaszx.jozwiak@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).