diff mbox

[dpdk-dev,v3] eventdev: add errno-style return values

Message ID 1489695139-13111-1-git-send-email-gage.eads@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Jerin Jacob
Headers

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Eads, Gage March 16, 2017, 8:12 p.m. UTC 
  This commit adds rte_errno return values to rte_event_enqueue_burst() and
rte_event_dequeue_burst().

These return values allows user software to differentiate between an
invalid argument (such as an invalid queue_id or sched_type in an enqueued
event) and backpressure from the event device.

The port and device ID checks are placed in RTE_LIBRTE_EVENTDEV_DEBUG
header guards to avoid the performance hit in non-debug execution.

Signed-off-by: Gage Eads <gage.eads@intel.com>
---
Changes for v2:
  - Remove rte_errno initialization
Changes for v3:
  - Fix checkpatch and check-git-log.sh errors

 lib/librte_eventdev/rte_eventdev.h | 42 +++++++++++++++++++++++++++++++++++---
 1 file changed, 39 insertions(+), 3 deletions(-)

Comments

Jerin Jacob March 17, 2017, 3:10 a.m. UTC | #1 
On Thu, Mar 16, 2017 at 03:12:19PM -0500, Gage Eads wrote:
> This commit adds rte_errno return values to rte_event_enqueue_burst() and
> rte_event_dequeue_burst().
> 
> These return values allows user software to differentiate between an
> invalid argument (such as an invalid queue_id or sched_type in an enqueued
> event) and backpressure from the event device.
> 
> The port and device ID checks are placed in RTE_LIBRTE_EVENTDEV_DEBUG
> header guards to avoid the performance hit in non-debug execution.
> 
> Signed-off-by: Gage Eads <gage.eads@intel.com>
> ---
> Changes for v2:
>   - Remove rte_errno initialization
> Changes for v3:
>   - Fix checkpatch and check-git-log.sh errors
> 
>  lib/librte_eventdev/rte_eventdev.h | 42 +++++++++++++++++++++++++++++++++++---
>  1 file changed, 39 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
> index 2b30a35..3e54b27 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -245,6 +245,7 @@ extern "C" {
>  
>  #include <rte_common.h>
>  #include <rte_memory.h>
> +#include <rte_errno.h>
>  
>  struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */
>  
> @@ -1118,9 +1119,14 @@ rte_event_schedule(uint8_t dev_id)
>   *   The number of event objects actually enqueued on the event device. The
>   *   return value can be less than the value of the *nb_events* parameter when
>   *   the event devices queue is full or if invalid parameters are specified in a
> - *   *rte_event*. If return value is less than *nb_events*, the remaining events
> - *   at the end of ev[] are not consumed,and the caller has to take care of them
> - *
> + *   *rte_event*. If the return value is less than *nb_events*, the remaining
> + *   events at the end of ev[] are not consumed and the caller has to take care
> + *   of them, and rte_errno is set accordingly. Possible errno values include:
> + *   -(-EINVAL) The port ID is invalid, device ID is invalid, an event's queue
> + *              ID is invalid, or an event's sched type doesn't match the
> + *              capabilities of the destination queue.
> + *   -(-ENOSPC) The event port was backpressured and unable to enqueue
> + *              one or more events.

Please check the review comments of v2
http://dpdk.org/ml/archives/dev/2017-March/060352.html

>   * @see rte_event_port_enqueue_depth()
>   */
>  static inline uint16_t
> @@ -1129,6 +1135,21 @@ rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
>  {
>  	struct rte_eventdev *dev = &rte_eventdevs[dev_id];
>  
> +	rte_errno = 0;

Why rte_errno = 0 is not in RTE_LIBRTE_EVENTDEV_DEBUG now in v3?

> +#ifdef RTE_LIBRTE_EVENTDEV_DEBUG

Please check the review comments of v2
http://dpdk.org/ml/archives/dev/2017-March/060352.html

It still fails.

n file included from
/export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.c:61:0:
/export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h: In
function ‘rte_event_enqueue_burst’:
/export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h:1140:40:
error: ‘RTE_EVENTDEV_DETACHED’ undeclared (first use in this function)
  if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {
                                        ^
/export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h:1140:40:
note: each undeclared identifier is reported only once for each function
it appears in
/export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h:1141:3:
error: implicit declaration of function ‘RTE_EDEV_LOG_DEBUG’
[-Werror=implicit-function-declaration]
   RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);
   ^

> +	if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {
> +		RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);
> +		rte_errno = -EINVAL;
> +		return 0;
> +	}
> +
> +	if (port_id >= dev->data->nb_ports) {
> +		RTE_EDEV_LOG_DEBUG("Invalid port_id=%d\n", port_id);
> +		rte_errno = -EINVAL;
> +		return 0;
> +	}
> +#endif
> +
>  	/*
>  	 * Allow zero cost non burst mode routine invocation if application
>  	 * requests nb_events as const one
> @@ -1239,6 +1260,21 @@ rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[],
>  {
>  	struct rte_eventdev *dev = &rte_eventdevs[dev_id];
>  
> +#ifdef RTE_LIBRTE_EVENTDEV_DEBUG
> +	rte_errno = 0;
> +	if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {
> +		RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);
> +		rte_errno = -EINVAL;
> +		return 0;
> +	}
> +
> +	if (port_id >= dev->data->nb_ports) {
> +		RTE_EDEV_LOG_DEBUG("Invalid port_id=%d\n", port_id);
> +		rte_errno = -EINVAL;
> +		return 0;
> +	}
> +#endif
> +
>  	/*
>  	 * Allow zero cost non burst mode routine invocation if application
>  	 * requests nb_events as const one
> -- 
> 2.7.4
>
Eads, Gage March 17, 2017, 2:34 p.m. UTC | #2 
Ah, sorry about that! I revised the v1 patch, not the v2 patch. I'll fix and resubmit.

>  -----Original Message-----

>  From: Jerin Jacob [mailto:jerin.jacob@caviumnetworks.com]

>  Sent: Thursday, March 16, 2017 10:11 PM

>  To: Eads, Gage <gage.eads@intel.com>

>  Cc: dev@dpdk.org; Richardson, Bruce <bruce.richardson@intel.com>;

>  hemant.agrawal@nxp.com; Van Haaren, Harry <harry.van.haaren@intel.com>;

>  nipun.gupta@nxp.com

>  Subject: Re: [PATCH v3] eventdev: add errno-style return values

>  

>  On Thu, Mar 16, 2017 at 03:12:19PM -0500, Gage Eads wrote:

>  > This commit adds rte_errno return values to rte_event_enqueue_burst()

>  > and rte_event_dequeue_burst().

>  >

>  > These return values allows user software to differentiate between an

>  > invalid argument (such as an invalid queue_id or sched_type in an

>  > enqueued

>  > event) and backpressure from the event device.

>  >

>  > The port and device ID checks are placed in RTE_LIBRTE_EVENTDEV_DEBUG

>  > header guards to avoid the performance hit in non-debug execution.

>  >

>  > Signed-off-by: Gage Eads <gage.eads@intel.com>

>  > ---

>  > Changes for v2:

>  >   - Remove rte_errno initialization

>  > Changes for v3:

>  >   - Fix checkpatch and check-git-log.sh errors

>  >

>  >  lib/librte_eventdev/rte_eventdev.h | 42

>  > +++++++++++++++++++++++++++++++++++---

>  >  1 file changed, 39 insertions(+), 3 deletions(-)

>  >

>  > diff --git a/lib/librte_eventdev/rte_eventdev.h

>  > b/lib/librte_eventdev/rte_eventdev.h

>  > index 2b30a35..3e54b27 100644

>  > --- a/lib/librte_eventdev/rte_eventdev.h

>  > +++ b/lib/librte_eventdev/rte_eventdev.h

>  > @@ -245,6 +245,7 @@ extern "C" {

>  >

>  >  #include <rte_common.h>

>  >  #include <rte_memory.h>

>  > +#include <rte_errno.h>

>  >

>  >  struct rte_mbuf; /* we just use mbuf pointers; no need to include

>  > rte_mbuf.h */

>  >

>  > @@ -1118,9 +1119,14 @@ rte_event_schedule(uint8_t dev_id)

>  >   *   The number of event objects actually enqueued on the event device. The

>  >   *   return value can be less than the value of the *nb_events* parameter

>  when

>  >   *   the event devices queue is full or if invalid parameters are specified in a

>  > - *   *rte_event*. If return value is less than *nb_events*, the remaining

>  events

>  > - *   at the end of ev[] are not consumed,and the caller has to take care of

>  them

>  > - *

>  > + *   *rte_event*. If the return value is less than *nb_events*, the remaining

>  > + *   events at the end of ev[] are not consumed and the caller has to take

>  care

>  > + *   of them, and rte_errno is set accordingly. Possible errno values include:

>  > + *   -(-EINVAL) The port ID is invalid, device ID is invalid, an event's queue

>  > + *              ID is invalid, or an event's sched type doesn't match the

>  > + *              capabilities of the destination queue.

>  > + *   -(-ENOSPC) The event port was backpressured and unable to enqueue

>  > + *              one or more events.

>  

>  Please check the review comments of v2

>  http://dpdk.org/ml/archives/dev/2017-March/060352.html

>  

>  >   * @see rte_event_port_enqueue_depth()

>  >   */

>  >  static inline uint16_t

>  > @@ -1129,6 +1135,21 @@ rte_event_enqueue_burst(uint8_t dev_id, uint8_t

>  > port_id,  {

>  >  	struct rte_eventdev *dev = &rte_eventdevs[dev_id];

>  >

>  > +	rte_errno = 0;

>  

>  Why rte_errno = 0 is not in RTE_LIBRTE_EVENTDEV_DEBUG now in v3?

>  

>  > +#ifdef RTE_LIBRTE_EVENTDEV_DEBUG

>  

>  Please check the review comments of v2

>  http://dpdk.org/ml/archives/dev/2017-March/060352.html

>  

>  It still fails.

>  

>  n file included from

>  /export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.c:61:0:

>  /export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h: In function

>  ‘rte_event_enqueue_burst’:

>  /export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h:1140:40:

>  error: ‘RTE_EVENTDEV_DETACHED’ undeclared (first use in this function)

>    if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {

>                                          ^

>  /export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h:1140:40:

>  note: each undeclared identifier is reported only once for each function it

>  appears in

>  /export/dpdk-next-eventdev/lib/librte_eventdev/rte_eventdev.h:1141:3:

>  error: implicit declaration of function ‘RTE_EDEV_LOG_DEBUG’

>  [-Werror=implicit-function-declaration]

>     RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);

>     ^

>  

>  > +	if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {

>  > +		RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);

>  > +		rte_errno = -EINVAL;

>  > +		return 0;

>  > +	}

>  > +

>  > +	if (port_id >= dev->data->nb_ports) {

>  > +		RTE_EDEV_LOG_DEBUG("Invalid port_id=%d\n", port_id);

>  > +		rte_errno = -EINVAL;

>  > +		return 0;

>  > +	}

>  > +#endif

>  > +

>  >  	/*

>  >  	 * Allow zero cost non burst mode routine invocation if application

>  >  	 * requests nb_events as const one

>  > @@ -1239,6 +1260,21 @@ rte_event_dequeue_burst(uint8_t dev_id, uint8_t

>  > port_id, struct rte_event ev[],  {

>  >  	struct rte_eventdev *dev = &rte_eventdevs[dev_id];

>  >

>  > +#ifdef RTE_LIBRTE_EVENTDEV_DEBUG

>  > +	rte_errno = 0;

>  > +	if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {

>  > +		RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);

>  > +		rte_errno = -EINVAL;

>  > +		return 0;

>  > +	}

>  > +

>  > +	if (port_id >= dev->data->nb_ports) {

>  > +		RTE_EDEV_LOG_DEBUG("Invalid port_id=%d\n", port_id);

>  > +		rte_errno = -EINVAL;

>  > +		return 0;

>  > +	}

>  > +#endif

>  > +

>  >  	/*

>  >  	 * Allow zero cost non burst mode routine invocation if application

>  >  	 * requests nb_events as const one

>  > --

>  > 2.7.4

>  >
diff mbox

Patch

diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index 2b30a35..3e54b27 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -245,6 +245,7 @@  extern "C" {
 
 #include <rte_common.h>
 #include <rte_memory.h>
+#include <rte_errno.h>
 
 struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */
 
@@ -1118,9 +1119,14 @@  rte_event_schedule(uint8_t dev_id)
  *   The number of event objects actually enqueued on the event device. The
  *   return value can be less than the value of the *nb_events* parameter when
  *   the event devices queue is full or if invalid parameters are specified in a
- *   *rte_event*. If return value is less than *nb_events*, the remaining events
- *   at the end of ev[] are not consumed,and the caller has to take care of them
- *
+ *   *rte_event*. If the return value is less than *nb_events*, the remaining
+ *   events at the end of ev[] are not consumed and the caller has to take care
+ *   of them, and rte_errno is set accordingly. Possible errno values include:
+ *   -(-EINVAL) The port ID is invalid, device ID is invalid, an event's queue
+ *              ID is invalid, or an event's sched type doesn't match the
+ *              capabilities of the destination queue.
+ *   -(-ENOSPC) The event port was backpressured and unable to enqueue
+ *              one or more events.
  * @see rte_event_port_enqueue_depth()
  */
 static inline uint16_t
@@ -1129,6 +1135,21 @@  rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
 {
 	struct rte_eventdev *dev = &rte_eventdevs[dev_id];
 
+	rte_errno = 0;
+#ifdef RTE_LIBRTE_EVENTDEV_DEBUG
+	if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {
+		RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);
+		rte_errno = -EINVAL;
+		return 0;
+	}
+
+	if (port_id >= dev->data->nb_ports) {
+		RTE_EDEV_LOG_DEBUG("Invalid port_id=%d\n", port_id);
+		rte_errno = -EINVAL;
+		return 0;
+	}
+#endif
+
 	/*
 	 * Allow zero cost non burst mode routine invocation if application
 	 * requests nb_events as const one
@@ -1239,6 +1260,21 @@  rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[],
 {
 	struct rte_eventdev *dev = &rte_eventdevs[dev_id];
 
+#ifdef RTE_LIBRTE_EVENTDEV_DEBUG
+	rte_errno = 0;
+	if (rte_eventdevs[dev_id].attached == RTE_EVENTDEV_DETACHED) {
+		RTE_EDEV_LOG_DEBUG("Invalid dev_id=%d\n", dev_id);
+		rte_errno = -EINVAL;
+		return 0;
+	}
+
+	if (port_id >= dev->data->nb_ports) {
+		RTE_EDEV_LOG_DEBUG("Invalid port_id=%d\n", port_id);
+		rte_errno = -EINVAL;
+		return 0;
+	}
+#endif
+
 	/*
 	 * Allow zero cost non burst mode routine invocation if application
 	 * requests nb_events as const one