[dpdk-dev] [PATCH v2 1/5] ethdev: modify rte API for single flow dump

[Ori Kam]

Hi Haifei,

> -----Original Message-----
> From: Haifei Luo <haifeil at nvidia.com>
> Sent: Wednesday, April 7, 2021 9:09 AM
> <andrew.rybchenko at oktetlabs.ru>
> Subject: [PATCH v2 1/5] ethdev: modify rte API for single flow dump
> 
> Previous implementations support dump all the flows. Add new arg
> rte_flow in rte_flow_dev_dump to dump one flow.
> 
> Signed-off-by: Haifei Luo <haifeil at nvidia.com>
> ---
>  app/test-pmd/config.c                |  2 +-
>  doc/guides/nics/mlx5.rst             |  9 ++++++---
>  doc/guides/prog_guide/rte_flow.rst   | 24 ++++++++++++++++++++++++
>  drivers/net/mlx5/linux/mlx5_socket.c |  2 +-
>  drivers/net/mlx5/mlx5.h              |  4 ++--
>  drivers/net/mlx5/mlx5_flow.c         |  9 ++++++---
>  drivers/net/octeontx2/otx2_flow.c    |  9 ++++++++-
>  lib/librte_ethdev/rte_flow.c         |  5 +++--
>  lib/librte_ethdev/rte_flow.h         |  5 ++++-
>  lib/librte_ethdev/rte_flow_driver.h  |  1 +
>  10 files changed, 56 insertions(+), 14 deletions(-)
> 
> diff --git a/app/test-pmd/config.c b/app/test-pmd/config.c
> index ef0b978..2bfa8fa 100644
> --- a/app/test-pmd/config.c
> +++ b/app/test-pmd/config.c
> @@ -1931,7 +1931,7 @@ struct rte_flow_shared_action *
>  			return -errno;
>  		}
>  	}
> -	ret = rte_flow_dev_dump(port_id, file, &error);
> +	ret = rte_flow_dev_dump(port_id, NULL, file, &error);
>  	if (ret) {
>  		port_flow_complain(&error);
>  		printf("Failed to dump flow: %s\n", strerror(-ret));
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index 8703435..17e6ada 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -1829,13 +1829,16 @@ all flows with assistance of external tools.
> 
>     .. code-block:: console
> 
> -       testpmd> flow dump <port> <output_file>
> +       To dump all flows:
> +       testpmd> flow dump <port> all <output_file>
> +       and dump one flow:
> +       testpmd> flow dump <port> rule <rule_id> <output_file>
> 
>     - call rte_flow_dev_dump api:
> 
>     .. code-block:: console
> 
> -       rte_flow_dev_dump(port, file, NULL);
> +       rte_flow_dev_dump(port, flow, file, NULL);
> 
>  #. Dump human-readable flows from raw file:
> 
> @@ -1843,4 +1846,4 @@ all flows with assistance of external tools.
> 
>     .. code-block:: console
> 
> -       mlx_steering_dump.py -f <output_file>
> +       mlx_steering_dump.py -f <output_file> -flowptr <flow_ptr>
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index aec2ba1..3bff7c3 100644
> --- a/doc/guides/prog_guide/rte_flow.rst
> +++ b/doc/guides/prog_guide/rte_flow.rst
> @@ -3018,6 +3018,30 @@ Return values:
> 
>  - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
> 
> +Dump
> +~~~~~
> +
> +Dump information for all or one flows.
> +
> +.. code-block:: c
> +
> +   int
> +   rte_flow_dev_dump(uint16_t port_id, struct rte_flow *flow,
> +                     FILE *file,
> +                     struct rte_flow_error *error);
> +
> +Arguments:
> +
> +- ``port_id``: port identifier of Ethernet device.
> +- ``flow``: flow rule handle to dump. NULL to dump all.
> +- ``file``: a pointer to a file for output
> +- ``error``: perform verbose error reporting if not NULL. PMDs initialize
> +  this structure in case of error only.
> +
> +Return values:
> +
> +- 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
> +
>  Query
>  ~~~~~
> 
> diff --git a/drivers/net/mlx5/linux/mlx5_socket.c
> b/drivers/net/mlx5/linux/mlx5_socket.c
> index b1f41bc..6e354f4 100644
> --- a/drivers/net/mlx5/linux/mlx5_socket.c
> +++ b/drivers/net/mlx5/linux/mlx5_socket.c
> @@ -84,7 +84,7 @@
>  	}
>  	/* Dump flow. */
>  	dev = &rte_eth_devices[port_id];
> -	ret = mlx5_flow_dev_dump(dev, file, NULL);
> +	ret = mlx5_flow_dev_dump(dev, NULL, file, NULL);
>  	/* Set-up the ancillary data and reply. */
>  	msg.msg_controllen = 0;
>  	msg.msg_control = NULL;
> diff --git a/drivers/net/mlx5/mlx5.h b/drivers/net/mlx5/mlx5.h
> index 6faba4f..d0b7908 100644
> --- a/drivers/net/mlx5/mlx5.h
> +++ b/drivers/net/mlx5/mlx5.h
> @@ -1245,8 +1245,8 @@ void mlx5_flow_async_pool_query_handle(struct
> mlx5_dev_ctx_shared *sh,
>  void mlx5_counter_free(struct rte_eth_dev *dev, uint32_t cnt);
>  int mlx5_counter_query(struct rte_eth_dev *dev, uint32_t cnt,
>  		       bool clear, uint64_t *pkts, uint64_t *bytes);
> -int mlx5_flow_dev_dump(struct rte_eth_dev *dev, FILE *file,
> -		       struct rte_flow_error *error);
> +int mlx5_flow_dev_dump(struct rte_eth_dev *dev, struct rte_flow *flow,
> +			FILE *file, struct rte_flow_error *error);
>  void mlx5_flow_rxq_dynf_metadata_set(struct rte_eth_dev *dev);
>  int mlx5_flow_get_aged_flows(struct rte_eth_dev *dev, void **contexts,
>  			uint32_t nb_contexts, struct rte_flow_error *error);
> diff --git a/drivers/net/mlx5/mlx5_flow.c b/drivers/net/mlx5/mlx5_flow.c
> index c347f81..bce6ab2 100644
> --- a/drivers/net/mlx5/mlx5_flow.c
> +++ b/drivers/net/mlx5/mlx5_flow.c
> @@ -7170,7 +7170,7 @@ struct mlx5_meter_domains_infos *
>   *   0 on success, a nagative value otherwise.
>   */
>  int
> -mlx5_flow_dev_dump(struct rte_eth_dev *dev,
> +mlx5_flow_dev_dump(struct rte_eth_dev *dev, struct rte_flow *flow_idx,
>  		   FILE *file,
>  		   struct rte_flow_error *error __rte_unused)
>  {
> @@ -7182,8 +7182,11 @@ struct mlx5_meter_domains_infos *
>  			return -errno;
>  		return -ENOTSUP;
>  	}
> -	return mlx5_devx_cmd_flow_dump(sh->fdb_domain, sh->rx_domain,
> -				       sh->tx_domain, file);
> +
> +	if (!flow_idx)
> +		return mlx5_devx_cmd_flow_dump(sh->fdb_domain,
> +				sh->rx_domain, sh->tx_domain, file);
> +	return -ENOTSUP;
>  }
> 
>  /**
> diff --git a/drivers/net/octeontx2/otx2_flow.c
> b/drivers/net/octeontx2/otx2_flow.c
> index 14ac9bc..1c90d75 100644
> --- a/drivers/net/octeontx2/otx2_flow.c
> +++ b/drivers/net/octeontx2/otx2_flow.c
> @@ -807,7 +807,7 @@
> 
>  static int
>  otx2_flow_dev_dump(struct rte_eth_dev *dev,
> -		  FILE *file,
> +		  struct rte_flow *flow, FILE *file,
>  		  struct rte_flow_error *error)
>  {
>  	struct otx2_eth_dev *hw = dev->data->dev_private;
> @@ -822,6 +822,13 @@
>  				   "Invalid file");
>  		return -EINVAL;
>  	}
> +	if (flow != NULL) {
> +		rte_flow_error_set(error, EINVAL,
> +				   RTE_FLOW_ERROR_TYPE_HANDLE,
> +				   NULL,
> +				   "Invalid argument");
> +		return -EINVAL;
> +	}
> 
>  	max_prio = hw->npc_flow.flow_max_priority;
> 
> diff --git a/lib/librte_ethdev/rte_flow.c b/lib/librte_ethdev/rte_flow.c
> index e07e617..7241f00 100644
> --- a/lib/librte_ethdev/rte_flow.c
> +++ b/lib/librte_ethdev/rte_flow.c
> @@ -1027,7 +1027,8 @@ enum rte_flow_conv_item_spec_type {
>  }
> 
>  int
> -rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error)
> +rte_flow_dev_dump(uint16_t port_id, struct rte_flow *flow,
> +			FILE *file, struct rte_flow_error *error)
>  {
>  	struct rte_eth_dev *dev = &rte_eth_devices[port_id];
>  	const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
> @@ -1037,7 +1038,7 @@ enum rte_flow_conv_item_spec_type {
>  		return -rte_errno;
>  	if (likely(!!ops->dev_dump)) {
>  		fts_enter(dev);
> -		ret = ops->dev_dump(dev, file, error);
> +		ret = ops->dev_dump(dev, flow, file, error);
>  		fts_exit(dev);
>  		return flow_err(port_id, ret, error);
>  	}
> diff --git a/lib/librte_ethdev/rte_flow.h b/lib/librte_ethdev/rte_flow.h
> index 6cc5713..a763af5 100644
> --- a/lib/librte_ethdev/rte_flow.h
> +++ b/lib/librte_ethdev/rte_flow.h
> @@ -3232,6 +3232,8 @@ enum rte_flow_conv_op {
>   *
>   * @param[in] port_id
>   *    The port identifier of the Ethernet device.
> + * @param[in] flow
> + *   The pointer of rte flow.
>   * @param[in] file
>   *   A pointer to a file for output.
>   * @param[out] error
> @@ -3242,7 +3244,8 @@ enum rte_flow_conv_op {
>   */
>  __rte_experimental
>  int
> -rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error);
> +rte_flow_dev_dump(uint16_t port_id, struct rte_flow *flow,
> +		FILE *file, struct rte_flow_error *error);
> 
>  /**
>   * Check if mbuf dynamic field for metadata is registered.
> diff --git a/lib/librte_ethdev/rte_flow_driver.h
> b/lib/librte_ethdev/rte_flow_driver.h
> index da594d9..6ae1f8c 100644
> --- a/lib/librte_ethdev/rte_flow_driver.h
> +++ b/lib/librte_ethdev/rte_flow_driver.h
> @@ -75,6 +75,7 @@ struct rte_flow_ops {
>  	/** See rte_flow_dev_dump(). */
>  	int (*dev_dump)
>  		(struct rte_eth_dev *dev,
> +		 struct rte_flow *flow,
>  		 FILE *file,
>  		 struct rte_flow_error *error);
>  	/** See rte_flow_get_aged_flows() */
> --
> 1.8.3.1

Acked-by: Ori Kam <orika at nvidia.com>
Thanks,
Ori