[dpdk-dev] [PATCH v1 16/16] ethdev: add port ID item and action to flow API

[Zhang, Qi Z]

> -----Original Message-----
> From: Adrien Mazarguil [mailto:adrien.mazarguil at 6wind.com]
> Sent: Wednesday, April 4, 2018 11:57 PM
> To: Thomas Monjalon <thomas at monjalon.net>; Yigit, Ferruh
> <ferruh.yigit at intel.com>; dev at dpdk.org
> Cc: Zhang, Qi Z <qi.z.zhang at intel.com>; Doherty, Declan
> <declan.doherty at intel.com>
> Subject: [PATCH v1 16/16] ethdev: add port ID item and action to flow API
> 
> RTE_FLOW_ACTION_TYPE_PORT_ID brings the ability to inject matching traffic
> into a different device, as identified by its DPDK port ID.
> 
> This is normally only supported when the target port ID has some kind of
> relationship with the port ID the flow rule is created against, such as being
> exposed by a common physical device (e.g. a different port of an Ethernet
> switch).
> 
> The converse pattern item, RTE_FLOW_ITEM_TYPE_PORT_ID, makes the
> resulting flow rule match traffic whose origin is the specified port ID. Note that
> specifying a port ID that differs from the one the flow rule is created against is
> normally meaningless (if even accepted), but can make sense if combined with
> the transfer attribute.
> 
> These must not be confused with their PHY_PORT counterparts, which refer to
> physical ports using device-specific indices, but unlike PORT_ID are not
> necessarily tied to DPDK port IDs.
> 
> Signed-off-by: Adrien Mazarguil <adrien.mazarguil at 6wind.com>
> Cc: "Zhang, Qi Z" <qi.z.zhang at intel.com>
> Cc: Declan Doherty <declan.doherty at intel.com>

Reviewed-by: Qi Zhang <qi.z.zhang at intel.com>

This patch cover 
http://dpdk.org/dev/patchwork/patch/36839/


> 
> ---
> 
> This patch provides the same functionality and supersedes Qi Zhang's
> "ether: add flow action to redirect packet to a port" [1].
> 
> The main differences are:
> 
> - Action is named PORT_ID instead of PORT.
> - Addition of a PORT_ID pattern item.
> - More extensive documentation.
> - Testpmd support.
> - rte_flow_copy() support.
> 
> [1] http://dpdk.org/ml/archives/dev/2018-April/094648.html
> ---
>  app/test-pmd/cmdline_flow.c                 | 57
> ++++++++++++++++++++++++
>  app/test-pmd/config.c                       |  2 +
>  doc/guides/prog_guide/rte_flow.rst          | 48 ++++++++++++++++++++
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst |  9 ++++
>  lib/librte_ether/rte_flow.c                 |  2 +
>  lib/librte_ether/rte_flow.h                 | 56
> +++++++++++++++++++++++
>  6 files changed, 174 insertions(+)
> 
> diff --git a/app/test-pmd/cmdline_flow.c b/app/test-pmd/cmdline_flow.c
> index c77525ad9..f85c1c57f 100644
> --- a/app/test-pmd/cmdline_flow.c
> +++ b/app/test-pmd/cmdline_flow.c
> @@ -89,6 +89,8 @@ enum index {
>  	ITEM_VF_ID,
>  	ITEM_PHY_PORT,
>  	ITEM_PHY_PORT_INDEX,
> +	ITEM_PORT_ID,
> +	ITEM_PORT_ID_ID,
>  	ITEM_RAW,
>  	ITEM_RAW_RELATIVE,
>  	ITEM_RAW_SEARCH,
> @@ -185,6 +187,9 @@ enum index {
>  	ACTION_PHY_PORT,
>  	ACTION_PHY_PORT_ORIGINAL,
>  	ACTION_PHY_PORT_INDEX,
> +	ACTION_PORT_ID,
> +	ACTION_PORT_ID_ORIGINAL,
> +	ACTION_PORT_ID_ID,
>  	ACTION_METER,
>  	ACTION_METER_ID,
>  };
> @@ -445,6 +450,7 @@ static const enum index next_item[] = {
>  	ITEM_PF,
>  	ITEM_VF,
>  	ITEM_PHY_PORT,
> +	ITEM_PORT_ID,
>  	ITEM_RAW,
>  	ITEM_ETH,
>  	ITEM_VLAN,
> @@ -491,6 +497,12 @@ static const enum index item_phy_port[] = {
>  	ZERO,
>  };
> 
> +static const enum index item_port_id[] = {
> +	ITEM_PORT_ID_ID,
> +	ITEM_NEXT,
> +	ZERO,
> +};
> +
>  static const enum index item_raw[] = {
>  	ITEM_RAW_RELATIVE,
>  	ITEM_RAW_SEARCH,
> @@ -627,6 +639,7 @@ static const enum index next_action[] = {
>  	ACTION_PF,
>  	ACTION_VF,
>  	ACTION_PHY_PORT,
> +	ACTION_PORT_ID,
>  	ACTION_METER,
>  	ZERO,
>  };
> @@ -668,6 +681,13 @@ static const enum index action_phy_port[] = {
>  	ZERO,
>  };
> 
> +static const enum index action_port_id[] = {
> +	ACTION_PORT_ID_ORIGINAL,
> +	ACTION_PORT_ID_ID,
> +	ACTION_NEXT,
> +	ZERO,
> +};
> +
>  static const enum index action_meter[] = {
>  	ACTION_METER_ID,
>  	ACTION_NEXT,
> @@ -1084,6 +1104,20 @@ static const struct token token_list[] = {
>  		.next = NEXT(item_phy_port, NEXT_ENTRY(UNSIGNED),
> item_param),
>  		.args = ARGS(ARGS_ENTRY(struct rte_flow_item_phy_port, index)),
>  	},
> +	[ITEM_PORT_ID] = {
> +		.name = "port_id",
> +		.help = "match traffic from/to a given DPDK port ID",
> +		.priv = PRIV_ITEM(PORT_ID,
> +				  sizeof(struct rte_flow_item_port_id)),
> +		.next = NEXT(item_port_id),
> +		.call = parse_vc,
> +	},
> +	[ITEM_PORT_ID_ID] = {
> +		.name = "id",
> +		.help = "DPDK port ID",
> +		.next = NEXT(item_port_id, NEXT_ENTRY(UNSIGNED), item_param),
> +		.args = ARGS(ARGS_ENTRY(struct rte_flow_item_port_id, id)),
> +	},
>  	[ITEM_RAW] = {
>  		.name = "raw",
>  		.help = "match an arbitrary byte string", @@ -1749,6 +1783,29 @@
> static const struct token token_list[] = {
>  					index)),
>  		.call = parse_vc_conf,
>  	},
> +	[ACTION_PORT_ID] = {
> +		.name = "port_id",
> +		.help = "direct matching traffic to a given DPDK port ID",
> +		.priv = PRIV_ACTION(PORT_ID,
> +				    sizeof(struct rte_flow_action_port_id)),
> +		.next = NEXT(action_port_id),
> +		.call = parse_vc,
> +	},
> +	[ACTION_PORT_ID_ORIGINAL] = {
> +		.name = "original",
> +		.help = "use original DPDK port ID if possible",
> +		.next = NEXT(action_port_id, NEXT_ENTRY(BOOLEAN)),
> +		.args = ARGS(ARGS_ENTRY_BF(struct rte_flow_action_port_id,
> +					   original, 1)),
> +		.call = parse_vc_conf,
> +	},
> +	[ACTION_PORT_ID_ID] = {
> +		.name = "id",
> +		.help = "DPDK port ID",
> +		.next = NEXT(action_port_id, NEXT_ENTRY(UNSIGNED)),
> +		.args = ARGS(ARGS_ENTRY(struct rte_flow_action_port_id, id)),
> +		.call = parse_vc_conf,
> +	},
>  	[ACTION_METER] = {
>  		.name = "meter",
>  		.help = "meter the directed packets at given id", diff --git
> a/app/test-pmd/config.c b/app/test-pmd/config.c index effb4ff81..4a273eff7
> 100644
> --- a/app/test-pmd/config.c
> +++ b/app/test-pmd/config.c
> @@ -961,6 +961,7 @@ static const struct {
>  	MK_FLOW_ITEM(PF, 0),
>  	MK_FLOW_ITEM(VF, sizeof(struct rte_flow_item_vf)),
>  	MK_FLOW_ITEM(PHY_PORT, sizeof(struct rte_flow_item_phy_port)),
> +	MK_FLOW_ITEM(PORT_ID, sizeof(struct rte_flow_item_port_id)),
>  	MK_FLOW_ITEM(RAW, sizeof(struct rte_flow_item_raw)),
>  	MK_FLOW_ITEM(ETH, sizeof(struct rte_flow_item_eth)),
>  	MK_FLOW_ITEM(VLAN, sizeof(struct rte_flow_item_vlan)), @@ -1059,6
> +1060,7 @@ static const struct {
>  	MK_FLOW_ACTION(PF, 0),
>  	MK_FLOW_ACTION(VF, sizeof(struct rte_flow_action_vf)),
>  	MK_FLOW_ACTION(PHY_PORT, sizeof(struct rte_flow_action_phy_port)),
> +	MK_FLOW_ACTION(PORT_ID, sizeof(struct rte_flow_action_port_id)),
>  	MK_FLOW_ACTION(METER, sizeof(struct rte_flow_action_meter)),  };
> 
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index 941285495..a94b84fb5 100644
> --- a/doc/guides/prog_guide/rte_flow.rst
> +++ b/doc/guides/prog_guide/rte_flow.rst
> @@ -607,6 +607,36 @@ associated with a port_id should be retrieved by
> other means.
>     | ``mask`` | ``index`` | zeroed to match any port index |
>     +----------+-----------+--------------------------------+
> 
> +Item: ``PORT_ID``
> +^^^^^^^^^^^^^^^^^
> +
> +Matches traffic originating from (ingress) or going to (egress) a given
> +DPDK port ID.
> +
> +Normally only supported if the port ID in question is known by the
> +underlying PMD and related to the device the flow rule is created against.
> +
> +This must not be confused with `Item: PHY_PORT`_ which refers to the
> +physical port of a device, whereas `Item: PORT_ID`_ refers to a
> +``struct rte_eth_dev`` object on the application side (also known as
> +"port representor" depending on the kind of underlying device).
> +
> +- Default ``mask`` matches the specified DPDK port ID.
> +
> +.. _table_rte_flow_item_phy_port:
> +
> +.. table:: PORT_ID
> +
> +   +----------+----------+-----------------------------+
> +   | Field    | Subfield | Value                       |
> +   +==========+==========+=============================+
> +   | ``spec`` | ``id``   | DPDK port ID                |
> +   +----------+----------+-----------------------------+
> +   | ``last`` | ``id``   | upper range value           |
> +   +----------+----------+-----------------------------+
> +   | ``mask`` | ``id``   | zeroed to match any port ID |
> +   +----------+----------+-----------------------------+
> +
>  Data matching item types
>  ~~~~~~~~~~~~~~~~~~~~~~~~
> 
> @@ -1436,6 +1466,24 @@ See `Item: PHY_PORT`_.
>     | ``index``    | physical port index                 |
>     +--------------+-------------------------------------+
> 
> +Action: ``PORT_ID``
> +^^^^^^^^^^^^^^^^^^^
> +Directs matching traffic to a given DPDK port ID.
> +
> +See `Item: PORT_ID`_.
> +
> +.. _table_rte_flow_action_phy_port:
> +
> +.. table:: PORT_ID
> +
> +   +--------------+---------------------------------------+
> +   | Field        | Value                                 |
> +   +==============+=======================================+
> +   | ``original`` | use original DPDK port ID if possible |
> +   +--------------+---------------------------------------+
> +   | ``id``       | DPDK port ID                          |
> +   +--------------+---------------------------------------+
> +
>  Action: ``METER``
>  ^^^^^^^^^^^^^^^^^
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index ca23ba146..e78f26dce 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -3212,6 +3212,10 @@ This section lists supported pattern items and their
> attributes, if any.
> 
>    - ``index {unsigned}``: physical port index.
> 
> +- ``port_id``: match traffic from/to a given DPDK port ID.
> +
> +  - ``id {unsigned}``: DPDK port ID.
> +
>  - ``raw``: match an arbitrary byte string.
> 
>    - ``relative {boolean}``: look for pattern after the previous item.
> @@ -3426,6 +3430,11 @@ This section lists supported actions and their
> attributes, if any.
>    - ``original {boolean}``: use original port index if possible.
>    - ``index {unsigned}``: physical port index.
> 
> +- ``port_id``: direct matching traffic to a given DPDK port ID.
> +
> +  - ``original {boolean}``: use original DPDK port ID if possible.
> +  - ``id {unsigned}``: DPDK port ID.
> +
>  Destroying flow rules
>  ~~~~~~~~~~~~~~~~~~~~~
> 
> diff --git a/lib/librte_ether/rte_flow.c b/lib/librte_ether/rte_flow.c index
> e0fd78dd5..3d8116ebd 100644
> --- a/lib/librte_ether/rte_flow.c
> +++ b/lib/librte_ether/rte_flow.c
> @@ -39,6 +39,7 @@ static const struct rte_flow_desc_data
> rte_flow_desc_item[] = {
>  	MK_FLOW_ITEM(PF, 0),
>  	MK_FLOW_ITEM(VF, sizeof(struct rte_flow_item_vf)),
>  	MK_FLOW_ITEM(PHY_PORT, sizeof(struct rte_flow_item_phy_port)),
> +	MK_FLOW_ITEM(PORT_ID, sizeof(struct rte_flow_item_port_id)),
>  	MK_FLOW_ITEM(RAW, sizeof(struct rte_flow_item_raw)),
>  	MK_FLOW_ITEM(ETH, sizeof(struct rte_flow_item_eth)),
>  	MK_FLOW_ITEM(VLAN, sizeof(struct rte_flow_item_vlan)), @@ -77,6
> +78,7 @@ static const struct rte_flow_desc_data rte_flow_desc_action[] = {
>  	MK_FLOW_ACTION(PF, 0),
>  	MK_FLOW_ACTION(VF, sizeof(struct rte_flow_action_vf)),
>  	MK_FLOW_ACTION(PHY_PORT, sizeof(struct rte_flow_action_phy_port)),
> +	MK_FLOW_ACTION(PORT_ID, sizeof(struct rte_flow_action_port_id)),
>  };
> 
>  static int
> diff --git a/lib/librte_ether/rte_flow.h b/lib/librte_ether/rte_flow.h index
> 49845ec35..af9bf3f25 100644
> --- a/lib/librte_ether/rte_flow.h
> +++ b/lib/librte_ether/rte_flow.h
> @@ -176,6 +176,16 @@ enum rte_flow_item_type {
>  	RTE_FLOW_ITEM_TYPE_PHY_PORT,
> 
>  	/**
> +	 * [META]
> +	 *
> +	 * Matches traffic originating from (ingress) or going to (egress) a
> +	 * given DPDK port ID.
> +	 *
> +	 * See struct rte_flow_item_port_id.
> +	 */
> +	RTE_FLOW_ITEM_TYPE_PORT_ID,
> +
> +	/**
>  	 * Matches a byte string of a given length at a given offset.
>  	 *
>  	 * See struct rte_flow_item_raw.
> @@ -410,6 +420,32 @@ static const struct rte_flow_item_phy_port
> rte_flow_item_phy_port_mask = {  #endif
> 
>  /**
> + * RTE_FLOW_ITEM_TYPE_PORT_ID
> + *
> + * Matches traffic originating from (ingress) or going to (egress) a
> +given
> + * DPDK port ID.
> + *
> + * Normally only supported if the port ID in question is known by the
> + * underlying PMD and related to the device the flow rule is created
> + * against.
> + *
> + * This must not be confused with @p PHY_PORT which refers to the
> +physical
> + * port of a device, whereas @p PORT_ID refers to a struct rte_eth_dev
> + * object on the application side (also known as "port representor"
> + * depending on the kind of underlying device).
> + */
> +struct rte_flow_item_port_id {
> +	uint32_t id; /**< DPDK port ID. */
> +};
> +
> +/** Default mask for RTE_FLOW_ITEM_TYPE_PORT_ID. */ #ifndef __cplusplus
> +static const struct rte_flow_item_port_id rte_flow_item_port_id_mask = {
> +	.id = 0xffffffff,
> +};
> +#endif
> +
> +/**
>   * RTE_FLOW_ITEM_TYPE_RAW
>   *
>   * Matches a byte string of a given length at a given offset.
> @@ -992,6 +1028,13 @@ enum rte_flow_action_type {
>  	RTE_FLOW_ACTION_TYPE_PHY_PORT,
> 
>  	/**
> +	 * Directs matching traffic to a given DPDK port ID.
> +	 *
> +	 * See struct rte_flow_action_port_id.
> +	 */
> +	RTE_FLOW_ACTION_TYPE_PORT_ID,
> +
> +	/**
>  	 * Traffic metering and policing (MTR).
>  	 *
>  	 * See struct rte_flow_action_meter.
> @@ -1123,6 +1166,19 @@ struct rte_flow_action_phy_port {  };
> 
>  /**
> + * RTE_FLOW_ACTION_TYPE_PORT_ID
> + *
> + * Directs matching traffic to a given DPDK port ID.
> + *
> + * @see RTE_FLOW_ITEM_TYPE_PORT_ID
> + */
> +struct rte_flow_action_port_id {
> +	uint32_t original:1; /**< Use original DPDK port ID if possible. */
> +	uint32_t reserved:31; /**< Reserved, must be zero. */
> +	uint32_t id; /**< DPDK port ID. */
> +};
> +
> +/**
>   * RTE_FLOW_ACTION_TYPE_METER
>   *
>   * Traffic metering and policing (MTR).
> --
> 2.11.0