diff mbox series

[v1] regexdev: add OOS capability definition

Message ID 20201020081624.25210-1-guyk@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v1] regexdev: add OOS capability definition |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-testing success Testing PASS
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK

Commit Message

Guy Kaneti Oct. 20, 2020, 8:16 a.m. UTC 
  From: Guy Kaneti <guyk@marvell.com>

Add out of order scan capability to check PMD
support for OOS.

Signed-off-by: Guy Kaneti <guyk@marvell.com>
---
 lib/librte_regexdev/rte_regexdev.h | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Ori Kam Oct. 20, 2020, 9:11 a.m. UTC | #1 
Hi Guy

> -----Original Message-----
> From: guyk@marvell.com <guyk@marvell.com>
> Sent: Tuesday, October 20, 2020 11:16 AM
> dev@dpdk.org; jerinj@marvell.com
> Subject: [PATCH v1] regexdev: add OOS capability definition
> 
> From: Guy Kaneti <guyk@marvell.com>
> 
> Add out of order scan capability to check PMD
> support for OOS.
> 
> Signed-off-by: Guy Kaneti <guyk@marvell.com>
> ---
>  lib/librte_regexdev/rte_regexdev.h | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/lib/librte_regexdev/rte_regexdev.h
> b/lib/librte_regexdev/rte_regexdev.h
> index 4077e62c9..60cccf816 100644
> --- a/lib/librte_regexdev/rte_regexdev.h
> +++ b/lib/librte_regexdev/rte_regexdev.h
> @@ -474,6 +474,14 @@ rte_regexdev_get_dev_id(const char *name);
>   * @see RTE_REGEXDEV_CFG_MATCH_ALL_F
>   */
> 
> +#define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22)
> +/**< RegEx device support out of order scan, this means the scan can be
> retired
> + * as soon as device returns completion.
> + *
> + * @see RTE_REGEX_QUEUE_PAIR_CFG_OOS_F
> + * @see struct rte_regexdev_info::regexdev_capa
> + */
> +
>  /* Enumerates PCRE rule flags */
>  #define RTE_REGEX_PCRE_RULE_ALLOW_EMPTY_F (1ULL << 0)
>  /**< When this flag is set, the pattern that can match against an empty string,
> --
> 2.28.0

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori
Thomas Monjalon Oct. 20, 2020, 12:37 p.m. UTC | #2 
20/10/2020 10:16, guyk@marvell.com:
> From: Guy Kaneti <guyk@marvell.com>
> 
> Add out of order scan capability to check PMD
> support for OOS.
> 
> Signed-off-by: Guy Kaneti <guyk@marvell.com>
> ---
> --- a/lib/librte_regexdev/rte_regexdev.h
> +++ b/lib/librte_regexdev/rte_regexdev.h
> +#define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22)
> +/**< RegEx device support out of order scan, this means the scan can be retired

s/support/supports/

What means "retired"?

> + * as soon as device returns completion.
> + *
> + * @see RTE_REGEX_QUEUE_PAIR_CFG_OOS_F
> + * @see struct rte_regexdev_info::regexdev_capa
> + */
Guy Kaneti Oct. 20, 2020, 2:24 p.m. UTC | #3 
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, October 20, 2020 3:37 PM
> To: Guy Kaneti <guyk@marvell.com>
> Cc: orika@nvidia.com; dev@dpdk.org; Smadar Fuks
> <smadarf@marvell.com>; Dovrat Zifroni <dovrat@marvell.com>; Jerin Jacob
> Kollanukkaran <jerinj@marvell.com>
> Subject: [EXT] Re: [dpdk-dev] [PATCH v1] regexdev: add OOS capability
> definition
> 
> External Email
> 
> ----------------------------------------------------------------------
> 20/10/2020 10:16, guyk@marvell.com:
> > From: Guy Kaneti <guyk@marvell.com>
> >
> > Add out of order scan capability to check PMD support for OOS.
> >
> > Signed-off-by: Guy Kaneti <guyk@marvell.com>
> > ---
> > --- a/lib/librte_regexdev/rte_regexdev.h
> > +++ b/lib/librte_regexdev/rte_regexdev.h
> > +#define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22) /**<
> RegEx
> > +device support out of order scan, this means the scan can be retired
> 
> s/support/supports/

I followed the other RTE_REGEXDEV_CAPA_ definitions 
I can fix it here

> 
> What means "retired"?

This was the original description in the rte_regexdev.h:

#define RTE_REGEX_QUEUE_PAIR_CFG_OOS_F (1ULL << 0)
/**< Out of order scan, If not set, a scan must retire after previously issued
 * in-order scans to this queue pair. If set, this scan can be retired as soon
 * as device returns completion. Application should not set out of order scan
 * flag if it needs to maintain the ingress order of scan request.

> 
> > + * as soon as device returns completion.
> > + *
> > + * @see RTE_REGEX_QUEUE_PAIR_CFG_OOS_F
> > + * @see struct rte_regexdev_info::regexdev_capa */
> 
>
Ori Kam Oct. 21, 2020, 7:15 a.m. UTC | #4 
Hi

> -----Original Message-----
> From: Guy Kaneti <guyk@marvell.com>
> Sent: Tuesday, October 20, 2020 5:24 PM
> Subject: RE: [EXT] Re: [dpdk-dev] [PATCH v1] regexdev: add OOS capability
> definition
> 
> 
> 
> > -----Original Message-----
> > From: Thomas Monjalon <thomas@monjalon.net>
> > Sent: Tuesday, October 20, 2020 3:37 PM
> > To: Guy Kaneti <guyk@marvell.com>
> > Cc: orika@nvidia.com; dev@dpdk.org; Smadar Fuks
> > <smadarf@marvell.com>; Dovrat Zifroni <dovrat@marvell.com>; Jerin Jacob
> > Kollanukkaran <jerinj@marvell.com>
> > Subject: [EXT] Re: [dpdk-dev] [PATCH v1] regexdev: add OOS capability
> > definition
> >
> > External Email
> >
> > ----------------------------------------------------------------------
> > 20/10/2020 10:16, guyk@marvell.com:
> > > From: Guy Kaneti <guyk@marvell.com>
> > >
> > > Add out of order scan capability to check PMD support for OOS.
> > >
> > > Signed-off-by: Guy Kaneti <guyk@marvell.com>
> > > ---
> > > --- a/lib/librte_regexdev/rte_regexdev.h
> > > +++ b/lib/librte_regexdev/rte_regexdev.h
> > > +#define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22) /**<
> > RegEx
> > > +device support out of order scan, this means the scan can be retired
> >
> > s/support/supports/
> 
> I followed the other RTE_REGEXDEV_CAPA_ definitions
> I can fix it here
> 
> >
> > What means "retired"?
> 
> This was the original description in the rte_regexdev.h:
> 
> #define RTE_REGEX_QUEUE_PAIR_CFG_OOS_F (1ULL << 0)
> /**< Out of order scan, If not set, a scan must retire after previously issued
>  * in-order scans to this queue pair. If set, this scan can be retired as soon
>  * as device returns completion. Application should not set out of order scan
>  * flag if it needs to maintain the ingress order of scan request.
> 
I agree with Thomas, it is not very clear, The idea was to show that a scan can return a result
From newer job/search on a specific queue before a previous job on the same queue is completed.

Best,
Ori

> >
> > > + * as soon as device returns completion.
> > > + *
> > > + * @see RTE_REGEX_QUEUE_PAIR_CFG_OOS_F
> > > + * @see struct rte_regexdev_info::regexdev_capa */
> >
> >
Guy Kaneti Oct. 21, 2020, 7:39 a.m. UTC | #5 
> -----Original Message-----
> From: Ori Kam <orika@nvidia.com>
> Sent: Wednesday, October 21, 2020 10:15 AM
> To: Guy Kaneti <guyk@marvell.com>; NBU-Contact-Thomas Monjalon
> <thomas@monjalon.net>
> Cc: dev@dpdk.org; Smadar Fuks <smadarf@marvell.com>; Dovrat Zifroni
> <dovrat@marvell.com>; Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> Subject: RE: [EXT] Re: [dpdk-dev] [PATCH v1] regexdev: add OOS capability
> definition
> 
> Hi
> 
> > -----Original Message-----
> > From: Guy Kaneti <guyk@marvell.com>
> > Sent: Tuesday, October 20, 2020 5:24 PM
> > Subject: RE: [EXT] Re: [dpdk-dev] [PATCH v1] regexdev: add OOS
> > capability definition
> >
> >
> >
> > > -----Original Message-----
> > > From: Thomas Monjalon <thomas@monjalon.net>
> > > Sent: Tuesday, October 20, 2020 3:37 PM
> > > To: Guy Kaneti <guyk@marvell.com>
> > > Cc: orika@nvidia.com; dev@dpdk.org; Smadar Fuks
> > > <smadarf@marvell.com>; Dovrat Zifroni <dovrat@marvell.com>; Jerin
> > > Jacob Kollanukkaran <jerinj@marvell.com>
> > > Subject: [EXT] Re: [dpdk-dev] [PATCH v1] regexdev: add OOS
> > > capability definition
> > >
> > > External Email
> > >
> > > --------------------------------------------------------------------
> > > --
> > > 20/10/2020 10:16, guyk@marvell.com:
> > > > From: Guy Kaneti <guyk@marvell.com>
> > > >
> > > > Add out of order scan capability to check PMD support for OOS.
> > > >
> > > > Signed-off-by: Guy Kaneti <guyk@marvell.com>
> > > > ---
> > > > --- a/lib/librte_regexdev/rte_regexdev.h
> > > > +++ b/lib/librte_regexdev/rte_regexdev.h
> > > > +#define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22)
> /**<
> > > RegEx
> > > > +device support out of order scan, this means the scan can be
> > > > +retired
> > >
> > > s/support/supports/
> >
> > I followed the other RTE_REGEXDEV_CAPA_ definitions I can fix it here
> >
> > >
> > > What means "retired"?
> >
> > This was the original description in the rte_regexdev.h:
> >
> > #define RTE_REGEX_QUEUE_PAIR_CFG_OOS_F (1ULL << 0) /**< Out of
> order
> > scan, If not set, a scan must retire after previously issued
> >  * in-order scans to this queue pair. If set, this scan can be retired
> > as soon
> >  * as device returns completion. Application should not set out of
> > order scan
> >  * flag if it needs to maintain the ingress order of scan request.
> >
> I agree with Thomas, it is not very clear, The idea was to show that a scan can
> return a result From newer job/search on a specific queue before a previous
> job on the same queue is completed.

How about this description:

/**< RegEx device supports out of order scan.
 * Out of order scan means the response of a specific job can be returned as
 * soon as it is ready even if previous jobs on the same queue didn't complete.
 *

> 
> Best,
> Ori
> 
> > >
> > > > + * as soon as device returns completion.
> > > > + *
> > > > + * @see RTE_REGEX_QUEUE_PAIR_CFG_OOS_F
> > > > + * @see struct rte_regexdev_info::regexdev_capa */
> > >
> > >
Thomas Monjalon Oct. 21, 2020, 7:53 a.m. UTC | #6 
21/10/2020 09:39, Guy Kaneti:
> From: Ori Kam <orika@nvidia.com>
> > From: Guy Kaneti <guyk@marvell.com>
> > > From: Thomas Monjalon <thomas@monjalon.net>
> > > > 20/10/2020 10:16, guyk@marvell.com:
> > > > > From: Guy Kaneti <guyk@marvell.com>
> > > > >
> > > > > Add out of order scan capability to check PMD support for OOS.
> > > > >
> > > > > Signed-off-by: Guy Kaneti <guyk@marvell.com>
> > > > > ---
> > > > > --- a/lib/librte_regexdev/rte_regexdev.h
> > > > > +++ b/lib/librte_regexdev/rte_regexdev.h
> > > > > +#define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22)
> > /**<
> > > > RegEx
> > > > > +device support out of order scan, this means the scan can be
> > > > > +retired
> > > >
> > > > s/support/supports/
> > >
> > > I followed the other RTE_REGEXDEV_CAPA_ definitions I can fix it here
> > >
> > > >
> > > > What means "retired"?
> > >
> > > This was the original description in the rte_regexdev.h:
> > >
> > > #define RTE_REGEX_QUEUE_PAIR_CFG_OOS_F (1ULL << 0) /**< Out of
> > order
> > > scan, If not set, a scan must retire after previously issued
> > >  * in-order scans to this queue pair. If set, this scan can be retired
> > > as soon
> > >  * as device returns completion. Application should not set out of
> > > order scan
> > >  * flag if it needs to maintain the ingress order of scan request.
> > >
> > I agree with Thomas, it is not very clear, The idea was to show that a scan can
> > return a result From newer job/search on a specific queue before a previous
> > job on the same queue is completed.
> 
> How about this description:
> 
> /**< RegEx device supports out of order scan.
>  * Out of order scan means the response of a specific job can be returned as
>  * soon as it is ready even if previous jobs on the same queue didn't complete.

A lot better :)
Thanks
diff mbox series

Patch

diff --git a/lib/librte_regexdev/rte_regexdev.h b/lib/librte_regexdev/rte_regexdev.h
index 4077e62c9..60cccf816 100644
--- a/lib/librte_regexdev/rte_regexdev.h
+++ b/lib/librte_regexdev/rte_regexdev.h
@@ -474,6 +474,14 @@  rte_regexdev_get_dev_id(const char *name);
  * @see RTE_REGEXDEV_CFG_MATCH_ALL_F
  */
 
+#define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22)
+/**< RegEx device support out of order scan, this means the scan can be retired
+ * as soon as device returns completion.
+ *
+ * @see RTE_REGEX_QUEUE_PAIR_CFG_OOS_F
+ * @see struct rte_regexdev_info::regexdev_capa
+ */
+
 /* Enumerates PCRE rule flags */
 #define RTE_REGEX_PCRE_RULE_ALLOW_EMPTY_F (1ULL << 0)
 /**< When this flag is set, the pattern that can match against an empty string,