[PATCH] doc: update match with compare result item limitation

[PATCH] doc: update match with compare result item limitation

[Suanming Mou]

In switch mode, when ``repr_matching_en`` flag is enabled in the devarg,
the match with compare result item is not supported to the ``ingress``
rule as an implicit REPRESENTED_PORT need to be added to the matcher.
That REPRESENTED_PORT item conflicts with the single item limitation for
match with compare result item.

Fixes: cb25df7ce9d6 ("net/mlx5: support comparison matching")
Cc: stable@dpdk.org

Signed-off-by: Suanming Mou <suanmingm@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7ced6ca8f9..43ae9070ab 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -460,6 +460,11 @@ Limitations
   - The field type ``RTE_FLOW_FIELD_VALUE`` must be the base (``b``) field.
   - The field type ``RTE_FLOW_FIELD_RANDOM`` can only be compared with
     ``RTE_FLOW_FIELD_VALUE``.
+  - In switch mode, when ``repr_matching_en`` flag is enabled in the devarg,
+    the match with compare result item is not supported to the ``ingress``
+    rule as an implicit REPRESENTED_PORT need to be added to the matcher.
+    That REPRESENTED_PORT item conflicts with the single item limitation for
+    match with compare result item.
 
 - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
   The flows within group 0 and set metadata action are rejected by hardware.
-- 
2.34.1

RE: [PATCH] doc: update match with compare result item limitation

[Bing Zhao]

The ` repr_matching_en ` flag is enabled (by default) can be added.

> -----Original Message-----
> From: Suanming Mou <suanmingm@nvidia.com>
> Sent: Tuesday, November 5, 2024 9:48 AM
> To: Dariusz Sosnowski <dsosnowski@nvidia.com>; Slava Ovsiienko
> <viacheslavo@nvidia.com>; Bing Zhao <bingz@nvidia.com>; Ori Kam
> <orika@nvidia.com>; Matan Azrad <matan@nvidia.com>
> Cc: dev@dpdk.org; stable@dpdk.org
> Subject: [PATCH] doc: update match with compare result item limitation
> 
> In switch mode, when ``repr_matching_en`` flag is enabled in the devarg,
> the match with compare result item is not supported to the ``ingress``
> rule as an implicit REPRESENTED_PORT need to be added to the matcher.
> That REPRESENTED_PORT item conflicts with the single item limitation for
> match with compare result item.
> 
> Fixes: cb25df7ce9d6 ("net/mlx5: support comparison matching")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Suanming Mou <suanmingm@nvidia.com>
> ---
>  doc/guides/nics/mlx5.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index
> 7ced6ca8f9..43ae9070ab 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -460,6 +460,11 @@ Limitations
>    - The field type ``RTE_FLOW_FIELD_VALUE`` must be the base (``b``)
> field.
>    - The field type ``RTE_FLOW_FIELD_RANDOM`` can only be compared with
>      ``RTE_FLOW_FIELD_VALUE``.
> +  - In switch mode, when ``repr_matching_en`` flag is enabled in the
> devarg,
> +    the match with compare result item is not supported to the
> ``ingress``
> +    rule as an implicit REPRESENTED_PORT need to be added to the matcher.
> +    That REPRESENTED_PORT item conflicts with the single item limitation
> for
> +    match with compare result item.
> 
>  - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
>    The flows within group 0 and set metadata action are rejected by
> hardware.
> --
> 2.34.1

RE: [PATCH] doc: update match with compare result item limitation

[Suanming Mou]

> -----Original Message-----
> From: Bing Zhao <bingz@nvidia.com>
> Sent: Tuesday, November 5, 2024 11:48 AM
> To: Suanming Mou <suanmingm@nvidia.com>; Dariusz Sosnowski
> <dsosnowski@nvidia.com>; Slava Ovsiienko <viacheslavo@nvidia.com>; Ori Kam
> <orika@nvidia.com>; Matan Azrad <matan@nvidia.com>
> Cc: dev@dpdk.org; stable@dpdk.org
> Subject: RE: [PATCH] doc: update match with compare result item limitation
> 
> The ` repr_matching_en ` flag is enabled (by default) can be added.

OK, let's update a new version.

> 
> > -----Original Message-----
> > From: Suanming Mou <suanmingm@nvidia.com>
> > Sent: Tuesday, November 5, 2024 9:48 AM
> > To: Dariusz Sosnowski <dsosnowski@nvidia.com>; Slava Ovsiienko
> > <viacheslavo@nvidia.com>; Bing Zhao <bingz@nvidia.com>; Ori Kam
> > <orika@nvidia.com>; Matan Azrad <matan@nvidia.com>
> > Cc: dev@dpdk.org; stable@dpdk.org
> > Subject: [PATCH] doc: update match with compare result item limitation
> >
> > In switch mode, when ``repr_matching_en`` flag is enabled in the
> > devarg, the match with compare result item is not supported to the
> > ``ingress`` rule as an implicit REPRESENTED_PORT need to be added to the
> matcher.
> > That REPRESENTED_PORT item conflicts with the single item limitation
> > for match with compare result item.
> >
> > Fixes: cb25df7ce9d6 ("net/mlx5: support comparison matching")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Suanming Mou <suanmingm@nvidia.com>
> > ---
> >  doc/guides/nics/mlx5.rst | 5 +++++
> >  1 file changed, 5 insertions(+)
> >
> > diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index
> > 7ced6ca8f9..43ae9070ab 100644
> > --- a/doc/guides/nics/mlx5.rst
> > +++ b/doc/guides/nics/mlx5.rst
> > @@ -460,6 +460,11 @@ Limitations
> >    - The field type ``RTE_FLOW_FIELD_VALUE`` must be the base (``b``)
> > field.
> >    - The field type ``RTE_FLOW_FIELD_RANDOM`` can only be compared
> with
> >      ``RTE_FLOW_FIELD_VALUE``.
> > +  - In switch mode, when ``repr_matching_en`` flag is enabled in the
> > devarg,
> > +    the match with compare result item is not supported to the
> > ``ingress``
> > +    rule as an implicit REPRESENTED_PORT need to be added to the
> matcher.
> > +    That REPRESENTED_PORT item conflicts with the single item
> > + limitation
> > for
> > +    match with compare result item.
> >
> >  - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
> >    The flows within group 0 and set metadata action are rejected by
> > hardware.
> > --
> > 2.34.1

[PATCH v2] doc: update match with compare result item limitation

[Suanming Mou]

In switch mode, when ``repr_matching_en`` flag is enabled in the devarg,
the match with compare result item is not supported to the ``ingress``
rule as an implicit REPRESENTED_PORT need to be added to the matcher.
That REPRESENTED_PORT item conflicts with the single item limitation for
match with compare result item.

Fixes: cb25df7ce9d6 ("net/mlx5: support comparison matching")
Cc: stable@dpdk.org

Signed-off-by: Suanming Mou <suanmingm@nvidia.com>
---

v2: Add `repr_matching_en`` enabled by default explanation.

---
 doc/guides/nics/mlx5.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7ced6ca8f9..64933a0823 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -460,6 +460,11 @@ Limitations
   - The field type ``RTE_FLOW_FIELD_VALUE`` must be the base (``b``) field.
   - The field type ``RTE_FLOW_FIELD_RANDOM`` can only be compared with
     ``RTE_FLOW_FIELD_VALUE``.
+  - In switch mode, when ``repr_matching_en`` flag is enabled (by default)
+    in the devarg, the match with compare result item is not supported to
+    the ``ingress`` rule as an implicit REPRESENTED_PORT need to be added to
+    the matcher. That REPRESENTED_PORT item conflicts with the single item
+    limitation for match with compare result item.
 
 - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
   The flows within group 0 and set metadata action are rejected by hardware.
-- 
2.34.1

RE: [PATCH v2] doc: update match with compare result item limitation

[Bing Zhao]

Thanks.

> -----Original Message-----
> From: Suanming Mou <suanmingm@nvidia.com>
> Sent: Wednesday, November 6, 2024 5:34 PM
> To: Dariusz Sosnowski <dsosnowski@nvidia.com>; Slava Ovsiienko
> <viacheslavo@nvidia.com>; Bing Zhao <bingz@nvidia.com>; Ori Kam
> <orika@nvidia.com>; Matan Azrad <matan@nvidia.com>
> Cc: dev@dpdk.org; stable@dpdk.org
> Subject: [PATCH v2] doc: update match with compare result item limitation
> 
> In switch mode, when ``repr_matching_en`` flag is enabled in the devarg,
> the match with compare result item is not supported to the ``ingress``
> rule as an implicit REPRESENTED_PORT need to be added to the matcher.
> That REPRESENTED_PORT item conflicts with the single item limitation for
> match with compare result item.
> 
> Fixes: cb25df7ce9d6 ("net/mlx5: support comparison matching")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Suanming Mou <suanmingm@nvidia.com>

Acked-by: Bing Zhao <bingz@nvidia.com>

> ---
> 
> v2: Add `repr_matching_en`` enabled by default explanation.
> 
> ---
>  doc/guides/nics/mlx5.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index
> 7ced6ca8f9..64933a0823 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -460,6 +460,11 @@ Limitations
>    - The field type ``RTE_FLOW_FIELD_VALUE`` must be the base (``b``)
> field.
>    - The field type ``RTE_FLOW_FIELD_RANDOM`` can only be compared with
>      ``RTE_FLOW_FIELD_VALUE``.
> +  - In switch mode, when ``repr_matching_en`` flag is enabled (by
> default)
> +    in the devarg, the match with compare result item is not supported to
> +    the ``ingress`` rule as an implicit REPRESENTED_PORT need to be added
> to
> +    the matcher. That REPRESENTED_PORT item conflicts with the single
> item
> +    limitation for match with compare result item.
> 
>  - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
>    The flows within group 0 and set metadata action are rejected by
> hardware.
> --
> 2.34.1

Re: [PATCH] doc: update match with compare result item limitation

[Stephen Hemminger]

On Tue, 5 Nov 2024 09:47:36 +0800
Suanming Mou <suanmingm@nvidia.com> wrote:

> +  - In switch mode, when ``repr_matching_en`` flag is enabled in the devarg,
> +    the match with compare result item is not supported to the ``ingress``
> +    rule as an implicit REPRESENTED_PORT need to be added to the matcher.
> +    That REPRESENTED_PORT item conflicts with the single item limitation for
> +    match with compare result item.

These sentences are hard to read, the wording is very awkward.

Have no detailed insight into the mlx5 matching but maybe this wording:

In switch mode, when the ``repr_matching_en`` flag is used then matching
with ingress comparison is not supported because an implicit rule is required
to match the REPRESENTED_PORT. And that implicit rule would conflict with the
ingress compare rule.

RE: [PATCH] doc: update match with compare result item limitation

[Bing Zhao]

@Suanming Mou, could you please reword the description as Stephen suggested and send a new version?
Hi, @Stephen Hemminger, PSB. Rule should be item, that would be more accurate.

> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Sent: Thursday, November 7, 2024 2:29 AM
> To: Suanming Mou <suanmingm@nvidia.com>
> Cc: Dariusz Sosnowski <dsosnowski@nvidia.com>; Slava Ovsiienko
> <viacheslavo@nvidia.com>; Bing Zhao <bingz@nvidia.com>; Ori Kam
> <orika@nvidia.com>; Matan Azrad <matan@nvidia.com>; dev@dpdk.org;
> stable@dpdk.org
> Subject: Re: [PATCH] doc: update match with compare result item limitation
> 
> External email: Use caution opening links or attachments
> 
> 
> On Tue, 5 Nov 2024 09:47:36 +0800
> Suanming Mou <suanmingm@nvidia.com> wrote:
> 
> > +  - In switch mode, when ``repr_matching_en`` flag is enabled in the
> devarg,
> > +    the match with compare result item is not supported to the
> ``ingress``
> > +    rule as an implicit REPRESENTED_PORT need to be added to the
> matcher.
> > +    That REPRESENTED_PORT item conflicts with the single item
> limitation for
> > +    match with compare result item.
> 
> These sentences are hard to read, the wording is very awkward.
> 
> Have no detailed insight into the mlx5 matching but maybe this wording:
> 
> In switch mode, when the ``repr_matching_en`` flag is used then matching
is used (by default)
> with ingress comparison is not supported because an implicit rule is
Implicit rule -> implicit item
> required to match the REPRESENTED_PORT. And that implicit rule would
Match the REPxxxx with the same rule
Rule-> item 
> conflict with the ingress compare rule.
Comparison item.