[PATCH v4 1/3] eventdev/eth_rx: add params set/get APIs

[Jerin Jacob]

On Fri, Feb 10, 2023 at 10:28 AM Naga Harish K S V
<s.v.naga.harish.k at intel.com> wrote:
>
> The adapter configuration parameters defined in the
> ``struct rte_event_eth_rx_adapter_runtime_params`` can be configured

`` character you can remove in git commit.

> and retrieved using ``rte_event_eth_rx_adapter_runtime_params_set`` and
> ``rte_event_eth_tx_adapter_runtime_params_get`` respectively.
>
> Signed-off-by: Naga Harish K S V <s.v.naga.harish.k at intel.com>
> ---
>
> +Set/Get adapter runtime configuration parameters
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +The runtime configuration parameters of adapter can be set/read using

read->get

> +``rte_event_eth_rx_adapter_runtime_params_set()`` and
> +``rte_event_eth_rx_adapter_runtime_params_get()`` respectively. The parameters that
> +can be set/read are defined in ``struct rte_event_eth_rx_adapter_runtime_params``.

read->get

> +
> +``rte_event_eth_rx_adapter_runtime_parmas_get()`` function retrieves the configuration
> +parameters that are defined in ``struct rte_event_eth_rx_adapter_runtime_params``.

This is duplicate. Please remove.

>
>  static int
> diff --git a/lib/eventdev/rte_event_eth_rx_adapter.h b/lib/eventdev/rte_event_eth_rx_adapter.h
> index f4652f40e8..9f781a5f69 100644
> --- a/lib/eventdev/rte_event_eth_rx_adapter.h
> +++ b/lib/eventdev/rte_event_eth_rx_adapter.h
> @@ -39,10 +39,21 @@
>   *  - rte_event_eth_rx_adapter_queue_stats_reset()
>   *  - rte_event_eth_rx_adapter_event_port_get()
>   *  - rte_event_eth_rx_adapter_instance_get()
> + *  - rte_event_eth_rx_adapter_runtime_params_get()
> + *  - rte_event_eth_rx_adapter_runtime_params_set()
>   *
>   * The application creates an ethernet to event adapter using
>   * rte_event_eth_rx_adapter_create_ext() or rte_event_eth_rx_adapter_create()
>   * or rte_event_eth_rx_adapter_create_with_params() functions.
> + *
> + * rte_event_eth_rx_adapter_create() or rte_event_eth_adapter_create_with_params()
> + * configures the adapter with default value of maximum packets processed per
> + * iteration to RXA_NB_RX_WORK_DEFAULT(128).
> + * rte_event_eth_rx_adapter_runtime_params_set() allows to re-configure maximum
> + * packets processed per iteration. This is alternative to using
> + * rte_event_eth_rx_adapter_create_ext() with parameter
> + * rte_event_eth_rx_adapter_conf::max_nb_rx

This session is only valid for SW driver. Let's move this as Doxgen comment
struct rte_event_eth_rx_adapter_runtime_params::max_nb_rx

> + *
>   * The adapter needs to know which ethernet rx queues to poll for mbufs as well
>   * as event device parameters such as the event queue identifier, event
>   * priority and scheduling type that the adapter should use when constructing
> @@ -121,6 +132,11 @@ struct rte_event_eth_rx_adapter_conf {
>          */
>  };
>
> +#define RXA_NB_RX_WORK_DEFAULT 128
> +/**< The default value for maximum number of packets processed by service
> + * based adapter per each call.

Don't expose internal symbols to public header file. Fix it by moving
rte_event_eth_rx_adapter_runtime_params_init() implementation .c file.
Since it is slow path function, there is no reason to be kept as
inline funciton.


> + */
> +
>  /**
>   * Function type used for adapter configuration callback. The callback is
>   * used to fill in members of the struct rte_event_eth_rx_adapter_conf, this
> @@ -299,6 +315,19 @@ struct rte_event_eth_rx_adapter_params {
>         /**< flag to indicate that event buffer is separate for each queue */
>  };
>
> +/**
> + * Adapter configuration parameters
> + */
> +struct rte_event_eth_rx_adapter_runtime_params {
> +       uint32_t max_nb_rx;
> +       /**< The adapter can return early if it has processed at least
> +        * max_nb_rx mbufs. This isn't treated as a requirement; batching may
> +        * cause the adapter to process more than max_nb_rx mbufs.

Also mention, valid only when !INTERNAL_PORT

> +        */
> +       uint32_t rsvd[15];
> +       /**< Reserved fields for future use */
> +};
> +
>  /**
>   *
>   * Callback function invoked by the SW adapter before it continues
> @@ -377,7 +406,7 @@ int rte_event_eth_rx_adapter_create_ext(uint8_t id, uint8_t dev_id,
>   * Create a new ethernet Rx event adapter with the specified identifier.
>   * This function uses an internal configuration function that creates an event
>   * port. This default function reconfigures the event device with an
> - * additional event port and setups up the event port using the port_config
> + * additional event port and setup the event port using the port_config
>   * parameter passed into this function. In case the application needs more
>   * control in configuration of the service, it should use the
>   * rte_event_eth_rx_adapter_create_ext() version.
> @@ -743,6 +772,76 @@ rte_event_eth_rx_adapter_instance_get(uint16_t eth_dev_id,
>                                       uint16_t rx_queue_id,
>                                       uint8_t *rxa_inst_id);
>
> +/**
> + * Initialize the adapter runtime configuration parameters with default values
> + *
> + * @param params
> + *  A pointer to structure of type struct rte_event_eth_rx_adapter_runtime_params
> + *
> + * @return
> + *  -  0: Success
> + *  - <0: Error code on failure
> + */
> +__rte_experimental
> +static inline int

Slowpath function, move to .c file.

> +rte_event_eth_rx_adapter_runtime_params_init(
> +               struct rte_event_eth_rx_adapter_runtime_params *params)
> +{
> +       if (params == NULL)
> +               return -EINVAL;
> +
> +       memset(params, 0, sizeof(struct rte_event_eth_rx_adapter_runtime_params));
> +       params->max_nb_rx = RXA_NB_RX_WORK_DEFAULT;
> +
> +       return 0;
> +}
> +
> +/**
> + * Set the adapter runtime configuration parameters
> + *
> + * This API is to be used after adding at least one queue to the adapter
> + * and is supported only for service based adapter.
> + *
> + * @param id
> + *  Adapter identifier
> + *
> + * @param params
> + *  A pointer to structure of type struct rte_event_eth_rx_adapter_runtime_params
> + *  with configuration parameter values. This structure can be initialized using
> + *  rte_event_eth_rx_adapter_runtime_params_init() to default values or
> + *  application may reset this structure and update the required fields.

I would suggest:

The structure must be initialized to default values.
rte_event_eth_rx_adapter_runtime_params_init() can be used to
initialize the default values
or application must reset this structure and update the required fields.


> + *
> + * @return
> + *  -  0: Success
> + *  - <0: Error code on failure
> + */
> +__rte_experimental
> +int
> +rte_event_eth_rx_adapter_runtime_params_set(uint8_t id,
> +               struct rte_event_eth_rx_adapter_runtime_params *params);
> +
> +/**
> + * Get the adapter runtime configuration parameters
> + *
> + * This API is to be used after adding at least one queue to the adapter
> + * and is supported only for service based adapter.
> + *
> + * @param id
> + *  Adapter identifier
> + *
> + * @param[out] params
> + *  A pointer to structure of type struct rte_event_eth_rx_adapter_runtime_params
> + *  containing valid adapter parameters when return value is 0.
> + *
> + * @return
> + *  -  0: Success
> + *  - <0: Error code on failure
> + */
> +__rte_experimental
> +int
> +rte_event_eth_rx_adapter_runtime_params_get(uint8_t id,
> +               struct rte_event_eth_rx_adapter_runtime_params *params);
> +
>  #ifdef __cplusplus
>  }
>  #endif
> diff --git a/lib/eventdev/version.map b/lib/eventdev/version.map
> index 3add5e3088..da97db794f 100644
> --- a/lib/eventdev/version.map
> +++ b/lib/eventdev/version.map
> @@ -121,6 +121,8 @@ EXPERIMENTAL {
>         rte_event_eth_tx_adapter_queue_stop;
>
>         # added in 23.03

Add rte_event_eth_rx_adapter_runtime_params_init() to version.map

Not reviewed other patches. Similar comments apply in other patches.

> +       rte_event_eth_rx_adapter_runtime_params_get;
> +       rte_event_eth_rx_adapter_runtime_params_set;
>         rte_event_timer_remaining_ticks_get;
>  };
>
> --
> 2.25.1
>