Re: [dpdk-dev] [PATCH] eventdev: add rx queue info get api

["Jayatheerthan, Jay" <jay.jayatheerthan@intel.com>]

Hi Ganapati,
Could you split these patches to logical units to make it easy to review ? In addition, add patch version in subject field.

-Jay


> -----Original Message-----
> From: Kundapura, Ganapati <ganapati.kundapura@intel.com>
> Sent: Tuesday, September 7, 2021 11:07 AM
> To: Jayatheerthan, Jay <jay.jayatheerthan@intel.com>; jerinjacobk@gmail.com
> Cc: dev@dpdk.org
> Subject: [PATCH] eventdev: add rx queue info get api
> 
> Added rte_event_eth_rx_adapter_queue_info_get() API to get rx queue
> information - event queue identifier, flags for handling received packets,
> schedular type, event priority, polling frequency of the receive queue
> and flow identifier in rte_event_eth_rx_adapter_queue_info structure
> 
> Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>
> 
> ---
> v2:
> * build failed due to missing entry in version.map
> * added entry in version.map
> ---
>  app/test/test_event_eth_rx_adapter.c               | 22 +++++++
>  .../prog_guide/event_ethernet_rx_adapter.rst       |  8 +++
>  lib/eventdev/eventdev_pmd.h                        | 31 +++++++++
>  lib/eventdev/rte_event_eth_rx_adapter.c            | 76 ++++++++++++++++++++++
>  lib/eventdev/rte_event_eth_rx_adapter.h            | 71 ++++++++++++++++++++
>  lib/eventdev/version.map                           |  1 +
>  6 files changed, 209 insertions(+)
> 
> diff --git a/app/test/test_event_eth_rx_adapter.c b/app/test/test_event_eth_rx_adapter.c
> index 9198767..c642e1b 100644
> --- a/app/test/test_event_eth_rx_adapter.c
> +++ b/app/test/test_event_eth_rx_adapter.c
> @@ -750,6 +750,27 @@ adapter_stats(void)
>  	return TEST_SUCCESS;
>  }
> 
> +static int
> +adapter_queue_info(void)
> +{
> +	int err;
> +	struct rte_event_eth_rx_adapter_queue_info queue_info;
> +
> +	err = rte_event_eth_rx_adapter_queue_info_get(TEST_INST_ID, TEST_DEV_ID,
> +						      0, &queue_info);
> +	TEST_ASSERT(err == 0, "Expected 0 got %d", err);
> +
> +	err = rte_event_eth_rx_adapter_queue_info_get(TEST_INST_ID, TEST_DEV_ID,
> +						      -1, &queue_info);
> +	TEST_ASSERT(err == -EINVAL, "Expected -EINVAL got %d", err);
> +
> +	err = rte_event_eth_rx_adapter_queue_info_get(TEST_INST_ID, TEST_DEV_ID,
> +						      0, NULL);
> +	TEST_ASSERT(err == -EINVAL, "Expected -EINVAL got %d", err);
> +
> +	return TEST_SUCCESS;
> +}
> +
>  static struct unit_test_suite event_eth_rx_tests = {
>  	.suite_name = "rx event eth adapter test suite",
>  	.setup = testsuite_setup,
> @@ -762,6 +783,7 @@ static struct unit_test_suite event_eth_rx_tests = {
>  					adapter_multi_eth_add_del),
>  		TEST_CASE_ST(adapter_create, adapter_free, adapter_start_stop),
>  		TEST_CASE_ST(adapter_create, adapter_free, adapter_stats),
> +		TEST_CASE_ST(adapter_create, adapter_free, adapter_queue_info),
>  		TEST_CASES_END() /**< NULL terminate unit test array */
>  	}
>  };
> diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> index c01e5a9..9897985 100644
> --- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> +++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> @@ -146,6 +146,14 @@ if the callback is supported, and the counts maintained by the service function,
>  if one exists. The service function also maintains a count of cycles for which
>  it was not able to enqueue to the event device.
> 
> +Getting Adapter queue info
> +~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +The  ``rte_event_eth_rx_adapter_queue_info_get()`` function reports
> +flags for handling received packets, event queue identifier, scheduar type,
> +event priority, polling frequency of the receive queue and flow identifier
> +in struct ``rte_event_eth_rx_adapter_queue_info``.
> +
>  Interrupt Based Rx Queues
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> diff --git a/lib/eventdev/eventdev_pmd.h b/lib/eventdev/eventdev_pmd.h
> index 0f724ac..20cc0a7 100644
> --- a/lib/eventdev/eventdev_pmd.h
> +++ b/lib/eventdev/eventdev_pmd.h
> @@ -561,6 +561,35 @@ typedef int (*eventdev_eth_rx_adapter_queue_del_t)
>  					const struct rte_eth_dev *eth_dev,
>  					int32_t rx_queue_id);
> 
> +struct rte_event_eth_rx_adapter_queue_info;
> +
> +/**
> + * Retrieve information about Rx queue. This callback is invoked if
> + * the caps returned from the eventdev_eth_rx_adapter_caps_get(, eth_port_id)
> + * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
> + *
> + * @param dev
> + *  Event device pointer
> + *
> + * @param eth_dev
> + *  Ethernet device pointer
> + *
> + * @param rx_queue_id
> + *  Ethernet device receive queue index.
> + *
> + * @param[out] info
> + *  Pointer to rte_event_eth_rx_adapter_queue_info structure
> + *
> + * @return
> + *  - 0: Success
> + *  - <0: Error code on failure.
> + */
> +typedef int (*eventdev_eth_rx_adapter_queue_info_get_t)
> +			(const struct rte_eventdev *dev,
> +			const struct rte_eth_dev *eth_dev,
> +			uint16_t rx_queue_id,
> +			struct rte_event_eth_rx_adapter_queue_info *info);
> +
>  /**
>   * Start ethernet Rx adapter. This callback is invoked if
>   * the caps returned from eventdev_eth_rx_adapter_caps_get(.., eth_port_id)
> @@ -1107,6 +1136,8 @@ struct rte_eventdev_ops {
>  	/**< Add Rx queues to ethernet Rx adapter */
>  	eventdev_eth_rx_adapter_queue_del_t eth_rx_adapter_queue_del;
>  	/**< Delete Rx queues from ethernet Rx adapter */
> +	eventdev_eth_rx_adapter_queue_info_get_t eth_rx_adapter_queue_info_get;
> +	/**< Get Rx adapter queue info */
>  	eventdev_eth_rx_adapter_start_t eth_rx_adapter_start;
>  	/**< Start ethernet Rx adapter */
>  	eventdev_eth_rx_adapter_stop_t eth_rx_adapter_stop;
> diff --git a/lib/eventdev/rte_event_eth_rx_adapter.c b/lib/eventdev/rte_event_eth_rx_adapter.c
> index 7c94c73..98184fb 100644
> --- a/lib/eventdev/rte_event_eth_rx_adapter.c
> +++ b/lib/eventdev/rte_event_eth_rx_adapter.c
> @@ -2811,3 +2811,79 @@ rte_event_eth_rx_adapter_cb_register(uint8_t id,
> 
>  	return 0;
>  }
> +
> +int
> +rte_event_eth_rx_adapter_queue_info_get(uint8_t id, uint16_t eth_dev_id,
> +			uint16_t rx_queue_id,
> +			struct rte_event_eth_rx_adapter_queue_info *info)
> +{
> +	struct rte_eventdev *dev;
> +	struct eth_device_info *dev_info;
> +	struct rte_event_eth_rx_adapter *rx_adapter;
> +	struct eth_rx_queue_info *queue_info;
> +	struct rte_event *qi_ev;
> +	int ret;
> +	uint32_t cap;
> +
> +	RTE_EVENT_ETH_RX_ADAPTER_ID_VALID_OR_ERR_RET(id, -EINVAL);
> +	RTE_ETH_VALID_PORTID_OR_ERR_RET(eth_dev_id, -EINVAL);
> +
> +	if (rx_queue_id >= rte_eth_devices[eth_dev_id].data->nb_rx_queues) {
> +		RTE_EDEV_LOG_ERR("Invalid rx queue_id %u", rx_queue_id);
> +		return -EINVAL;
> +	}
> +
> +	if (info == NULL) {
> +		RTE_EDEV_LOG_ERR("Rx queue info cannot be NULL");
> +		return -EINVAL;
> +	}
> +
> +	rx_adapter = rxa_id_to_adapter(id);
> +	if (rx_adapter == NULL)
> +		return -EINVAL;
> +
> +	dev = &rte_eventdevs[rx_adapter->eventdev_id];
> +	ret = rte_event_eth_rx_adapter_caps_get(rx_adapter->eventdev_id,
> +						eth_dev_id,
> +						&cap);
> +	if (ret) {
> +		RTE_EDEV_LOG_ERR("Failed to get adapter caps edev %" PRIu8
> +				 "eth port %" PRIu16, id, eth_dev_id);
> +		return ret;
> +	}
> +
> +	if (cap & RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT) {
> +		RTE_FUNC_PTR_OR_ERR_RET(
> +				*dev->dev_ops->eth_rx_adapter_queue_info_get,
> +				-ENOTSUP);
> +		ret = (*dev->dev_ops->eth_rx_adapter_queue_info_get)(dev,
> +						&rte_eth_devices[eth_dev_id],
> +						rx_queue_id,
> +						info);
> +		return ret;
> +	}
> +
> +	dev_info = &rx_adapter->eth_devices[eth_dev_id];
> +
> +	queue_info = &dev_info->rx_queue[rx_queue_id];
> +	if (!queue_info->queue_enabled) {
> +		RTE_EDEV_LOG_ERR("Rx queue %u not added", rx_queue_id);
> +		return -EINVAL;
> +	}
> +
> +	qi_ev = (struct rte_event *)&queue_info->event;
> +
> +	memset(info, 0, sizeof(*info));
> +	info->servicing_weight = queue_info->wt;
> +	info->event_queue_id = qi_ev->queue_id;
> +	info->sched_type = qi_ev->sched_type;
> +	info->priority = qi_ev->priority;
> +	info->rx_queue_flags = 0;
> +	if (queue_info->flow_id_mask != 0) {
> +		info->rx_queue_flags |=
> +				RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID;
> +		info->flow_id = qi_ev->flow_id;
> +	}
> +
> +	return 0;
> +}
> diff --git a/lib/eventdev/rte_event_eth_rx_adapter.h b/lib/eventdev/rte_event_eth_rx_adapter.h
> index 182dd2e..75c0010 100644
> --- a/lib/eventdev/rte_event_eth_rx_adapter.h
> +++ b/lib/eventdev/rte_event_eth_rx_adapter.h
> @@ -33,6 +33,7 @@
>   *  - rte_event_eth_rx_adapter_stop()
>   *  - rte_event_eth_rx_adapter_stats_get()
>   *  - rte_event_eth_rx_adapter_stats_reset()
> + *  - rte_event_eth_rx_adapter_queue_info_get()
>   *
>   * The application creates an ethernet to event adapter using
>   * rte_event_eth_rx_adapter_create_ext() or rte_event_eth_rx_adapter_create()
> @@ -140,6 +141,56 @@ typedef int (*rte_event_eth_rx_adapter_conf_cb) (uint8_t id, uint8_t dev_id,
>  			void *arg);
> 
>  /**
> + * Rx queue info
> + */
> +struct rte_event_eth_rx_adapter_queue_info {
> +	uint32_t rx_queue_flags;
> +	/**< Flags for handling received packets
> +	 * @see RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID
> +	 */
> +	uint16_t servicing_weight;
> +	/**< Relative polling frequency of ethernet receive queue when the
> +	 * adapter uses a service core function for ethernet to event device
> +	 * transfers. If it is set to zero, the Rx queue is interrupt driven
> +	 * (unless rx queue interrupts are not enabled for the ethernet
> +	 * device).
> +	 */
> +
> +	uint8_t event_queue_id;
> +	/**< Targeted event queue identifier for the enqueue or
> +	 * dequeue operation.
> +	 * The value must be in the range of
> +	 * [0, nb_event_queues - 1] which previously supplied to
> +	 * rte_event_dev_configure().
> +	 */
> +
> +	uint8_t sched_type;
> +	/**< Scheduler synchronization type (RTE_SCHED_TYPE_*)
> +	 * associated with flow id on a given event queue
> +	 * for the enqueue and dequeue operation.
> +	 */
> +
> +	uint8_t priority;
> +	/**< Event priority relative to other events in the
> +	 * event queue. The requested priority should in the
> +	 * range of  [RTE_EVENT_DEV_PRIORITY_HIGHEST,
> +	 * RTE_EVENT_DEV_PRIORITY_LOWEST].
> +	 * The implementation shall normalize the requested
> +	 * priority to supported priority value.
> +	 * Valid when the device has
> +	 * RTE_EVENT_DEV_CAP_EVENT_QOS capability.
> +	 */
> +
> +	uint32_t flow_id;
> +	/**< Targeted flow identifier for the enqueue and
> +	 * dequeue operation.
> +	 * The value must be in the range of
> +	 * [0, nb_event_queue_flows - 1] which
> +	 * previously supplied to rte_event_dev_configure().
> +	 */
> +};
> +
> +/**
>   * Rx queue configuration structure
>   */
>  struct rte_event_eth_rx_adapter_queue_conf {
> @@ -575,6 +626,26 @@ int rte_event_eth_rx_adapter_queue_event_vector_config(
>  	uint8_t id, uint16_t eth_dev_id, int32_t rx_queue_id,
>  	struct rte_event_eth_rx_adapter_event_vector_config *config);
> 
> +/**
> + * Retrieve information about Rx queue.
> + *
> + * @param id
> + *  Adapter identifier.
> + * @param eth_dev_id
> + *  Port identifier of Ethernet device.
> + * @param rx_queue_id
> + *  Ethernet device receive queue index.
> + * @param info
> + *  Pointer to struct rte_event_eth_rx_adapter_queue_info
> + * @return
> + *  - 0: Success, Receive queue added correctly.
> + *  - <0: Error code on failure.
> + */
> +int rte_event_eth_rx_adapter_queue_info_get(uint8_t id,
> +		     uint16_t eth_dev_id,
> +		     uint16_t rx_queue_id,
> +		     struct rte_event_eth_rx_adapter_queue_info *info);
> +
>  #ifdef __cplusplus
>  }
>  #endif
> diff --git a/lib/eventdev/version.map b/lib/eventdev/version.map
> index 8862562..258affd 100644
> --- a/lib/eventdev/version.map
> +++ b/lib/eventdev/version.map
> @@ -143,6 +143,7 @@ EXPERIMENTAL {
>  	rte_event_vector_pool_create;
>  	rte_event_eth_rx_adapter_vector_limits_get;
>  	rte_event_eth_rx_adapter_queue_event_vector_config;
> +	rte_event_eth_rx_adapter_queue_info_get;
>  	__rte_eventdev_trace_crypto_adapter_enqueue;
>  };
> 
> --
> 2.6.4