[PATCH] doc: update sample action description for mlx5

[PATCH] doc: update sample action description for mlx5

[Jiawei Wang]

This patch adds mlx5 description about E-Switch mirroring
flow (RTE_FLOW_ACTION_TYPE_SAMPLE with sample ratio=1) with
encap action, then supports the uplink port only in the sample
actions list or in the one flow.

Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index bb436892a0..81986253bf 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -432,6 +432,8 @@ Limitations
     sample actions list.
   - For E-Switch mirroring flow, supports ``RAW ENCAP``, ``Port ID``,
     ``VXLAN ENCAP``, ``NVGRE ENCAP`` in the sample actions list.
+  - For E-Switch mirroring flow, supports ``ENCAP`` actions only to the
+    UpLink Port and in either of sample actions list or in the flow.
   - For ConnectX-5 trusted device, the application metadata with SET_TAG index 0
     is not supported before ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action.
 
-- 
2.18.1

Re: [PATCH] doc: update sample action description for mlx5

[Thomas Monjalon]

14/10/2022 12:14, Jiawei Wang:
> This patch adds mlx5 description about E-Switch mirroring
> flow (RTE_FLOW_ACTION_TYPE_SAMPLE with sample ratio=1) with
> encap action, then supports the uplink port only in the sample
> actions list or in the one flow.
> 
> Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
[...]
> +  - For E-Switch mirroring flow, supports ``ENCAP`` actions only to the
> +    UpLink Port and in either of sample actions list or in the flow.

Sorry I don't understand the second part of the sentence:
"and in either of sample actions list or in the flow."

Please could you explain so we can find a simpler wording?

RE: [PATCH] doc: update sample action description for mlx5

[Jiawei(Jonny) Wang]

Hi,

Sorry for the late reply.

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Friday, October 14, 2022 9:11 PM
> To: Jiawei(Jonny) Wang <jiaweiw@nvidia.com>
> Cc: Raslan Darawsheh <rasland@nvidia.com>; Asaf Penso <asafp@nvidia.com>;
> Matan Azrad <matan@nvidia.com>; Slava Ovsiienko
> <viacheslavo@nvidia.com>; dev@dpdk.org
> Subject: Re: [PATCH] doc: update sample action description for mlx5
> 
> 14/10/2022 12:14, Jiawei Wang:
> > This patch adds mlx5 description about E-Switch mirroring flow
> > (RTE_FLOW_ACTION_TYPE_SAMPLE with sample ratio=1) with encap action,
> > then supports the uplink port only in the sample actions list or in
> > the one flow.
> >
> > Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
> [...]
> > +  - For E-Switch mirroring flow, supports ``ENCAP`` actions only to the
> > +    UpLink Port and in either of sample actions list or in the flow.
> 
> Sorry I don't understand the second part of the sentence:
> "and in either of sample actions list or in the flow."
> 
> Please could you explain so we can find a simpler wording?
> 

RTE sample action support a list of actions that be defined as below structure:
	struct rte_flow_action_sample {
		uint32_t ratio; /**< packets sampled equals to '1/ratio'. */
		const struct rte_flow_action *actions;
			/**< sub-action list specific for the sampling hit cases. */
	};

So the second part meaning that 'encap' with 'port' combination can be in the 'sub-action' list of sample
Or flow actions while user calls rte_flow_create(,, actions[]);

>