[v3] eventdev: add experimental tag back

Message ID 1556170955-40555-1-git-send-email-nikhil.rao@intel.com (mailing list archive)
State Superseded, archived
Headers
Series [v3] eventdev: add experimental tag back |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS

Commit Message

Rao, Nikhil April 25, 2019, 5:42 a.m. UTC
  Add the experimental tag back to the Rx event adapter callback,
the Rx event callback register and the Rx event adapter statistics
retrieval functions due to API change to be proposed in a
future patch.

This patch also adds the experimental tag to these
function definition and adds the functions to the EXPERIMENTAL
section of the map file, these were missing previously.

Fixes: 80bdf91dc8ee ("eventdev: promote adapter functions as stable")
Cc: jerinj@marvell.com

Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
---

v3:
* add experimental tag to the Rx event adapter stats retrieval function

v2:
* add patch explanation to commit message

 lib/librte_eventdev/rte_event_eth_rx_adapter.c | 11 ++++++-----
 lib/librte_eventdev/rte_event_eth_rx_adapter.h | 17 +++++++++++++++--
 lib/librte_eventdev/rte_eventdev_version.map   |  8 +++++++-
 3 files changed, 28 insertions(+), 8 deletions(-)
  

Comments

Kevin Traynor April 25, 2019, 9:55 a.m. UTC | #1
On 25/04/2019 06:42, Nikhil Rao wrote:
> Add the experimental tag back to the Rx event adapter callback,
> the Rx event callback register and the Rx event adapter statistics
> retrieval functions due to API change to be proposed in a
> future patch.
> 
> This patch also adds the experimental tag to these
> function definition and adds the functions to the EXPERIMENTAL
> section of the map file, these were missing previously.
> 
> Fixes: 80bdf91dc8ee ("eventdev: promote adapter functions as stable")
> Cc: jerinj@marvell.com
> 
> Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
> ---
> 
> v3:
> * add experimental tag to the Rx event adapter stats retrieval function
> 
> v2:
> * add patch explanation to commit message
> 
>  lib/librte_eventdev/rte_event_eth_rx_adapter.c | 11 ++++++-----
>  lib/librte_eventdev/rte_event_eth_rx_adapter.h | 17 +++++++++++++++--
>  lib/librte_eventdev/rte_eventdev_version.map   |  8 +++++++-

'Eventdev Ethdev Rx Adapter API' in MAINTAINER should be updated also

>  3 files changed, 28 insertions(+), 8 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.c b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
> index 8d178be..27e0fe7 100644
> --- a/lib/librte_eventdev/rte_event_eth_rx_adapter.c
> +++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
> @@ -2296,7 +2296,7 @@ static int rxa_sw_add(struct rte_event_eth_rx_adapter *rx_adapter,
>  	return rxa_ctrl(id, 0);
>  }
>  
> -int
> +int __rte_experimental
>  rte_event_eth_rx_adapter_stats_get(uint8_t id,
>  			       struct rte_event_eth_rx_adapter_stats *stats)

I guess if this API is experimental, then the struct should also remain
experimental

>  {
> @@ -2383,10 +2383,11 @@ static int rxa_sw_add(struct rte_event_eth_rx_adapter *rx_adapter,
>  	return rx_adapter->service_inited ? 0 : -ESRCH;
>  }
>  
> -int rte_event_eth_rx_adapter_cb_register(uint8_t id,
> -					uint16_t eth_dev_id,
> -					rte_event_eth_rx_adapter_cb_fn cb_fn,
> -					void *cb_arg)
> +int __rte_experimental
> +rte_event_eth_rx_adapter_cb_register(uint8_t id,
> +				uint16_t eth_dev_id,
> +				rte_event_eth_rx_adapter_cb_fn cb_fn,
> +				void *cb_arg)

Unrelated indent changes - not sure if they are intentional

>  {
>  	struct rte_event_eth_rx_adapter *rx_adapter;
>  	struct eth_device_info *dev_info;
> diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.h b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> index cf23cde..176f8ca 100644
> --- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> +++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> @@ -173,6 +173,9 @@ struct rte_event_eth_rx_adapter_queue_conf {
>  };
>  
>  /**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice
> + *
>   * A structure used to retrieve statistics for an eth rx adapter instance.
>   */
>  struct rte_event_eth_rx_adapter_stats {
> @@ -201,6 +204,9 @@ struct rte_event_eth_rx_adapter_stats {
>  };
>  
>  /**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice
> + *
>   * Callback function invoked by the SW adapter before it continues
>   * to process packets. The callback is passed the size of the enqueue
>   * buffer in the SW adapter and the occupancy of the buffer. The
> @@ -392,6 +398,9 @@ int rte_event_eth_rx_adapter_queue_del(uint8_t id, uint16_t eth_dev_id,
>  int rte_event_eth_rx_adapter_stop(uint8_t id);
>  
>  /**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice
> + *
>   * Retrieve statistics for an adapter
>   *
>   * @param id
> @@ -404,7 +413,8 @@ int rte_event_eth_rx_adapter_queue_del(uint8_t id, uint16_t eth_dev_id,
>   *  - 0: Success, retrieved successfully.
>   *  - <0: Error code on failure.
>   */
> -int rte_event_eth_rx_adapter_stats_get(uint8_t id,
> +int __rte_experimental
> +rte_event_eth_rx_adapter_stats_get(uint8_t id,
>  				struct rte_event_eth_rx_adapter_stats *stats);
>  
>  /**
> @@ -437,6 +447,9 @@ int rte_event_eth_rx_adapter_stats_get(uint8_t id,
>  int rte_event_eth_rx_adapter_service_id_get(uint8_t id, uint32_t *service_id);
>  
>  /**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice
> + *
>   * Register callback to process Rx packets, this is supported for
>   * SW based packet transfers.
>   * @see rte_event_eth_rx_cb_fn
> @@ -453,7 +466,7 @@ int rte_event_eth_rx_adapter_stats_get(uint8_t id,
>   *  - 0: Success
>   *  - <0: Error code on failure.
>   */
> -int
> +int __rte_experimental
>  rte_event_eth_rx_adapter_cb_register(uint8_t id,
>  				uint16_t eth_dev_id,
>  				rte_event_eth_rx_adapter_cb_fn cb_fn,
> diff --git a/lib/librte_eventdev/rte_eventdev_version.map b/lib/librte_eventdev/rte_eventdev_version.map
> index 88c3ce5..55c56e3 100644
> --- a/lib/librte_eventdev/rte_eventdev_version.map
> +++ b/lib/librte_eventdev/rte_eventdev_version.map
> @@ -63,7 +63,6 @@ DPDK_17.11 {
>  	rte_event_eth_rx_adapter_queue_del;
>  	rte_event_eth_rx_adapter_service_id_get;
>  	rte_event_eth_rx_adapter_start;
> -	rte_event_eth_rx_adapter_stats_get;
>  	rte_event_eth_rx_adapter_stats_reset;
>  	rte_event_eth_rx_adapter_stop;
>  } DPDK_17.08;
> @@ -124,3 +123,10 @@ DPDK_19.05 {
>  	rte_event_timer_arm_tmo_tick_burst;
>  	rte_event_timer_cancel_burst;
>  } DPDK_18.05;
> +
> +EXPERIMENTAL {
> +	global:
> +
> +	rte_event_eth_rx_adapter_cb_register;

As per Jerin's comment, it needs to be removed from 19.05 section also

> +	rte_event_eth_rx_adapter_stats_get;
> +};
>
  

Patch

diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.c b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
index 8d178be..27e0fe7 100644
--- a/lib/librte_eventdev/rte_event_eth_rx_adapter.c
+++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
@@ -2296,7 +2296,7 @@  static int rxa_sw_add(struct rte_event_eth_rx_adapter *rx_adapter,
 	return rxa_ctrl(id, 0);
 }
 
-int
+int __rte_experimental
 rte_event_eth_rx_adapter_stats_get(uint8_t id,
 			       struct rte_event_eth_rx_adapter_stats *stats)
 {
@@ -2383,10 +2383,11 @@  static int rxa_sw_add(struct rte_event_eth_rx_adapter *rx_adapter,
 	return rx_adapter->service_inited ? 0 : -ESRCH;
 }
 
-int rte_event_eth_rx_adapter_cb_register(uint8_t id,
-					uint16_t eth_dev_id,
-					rte_event_eth_rx_adapter_cb_fn cb_fn,
-					void *cb_arg)
+int __rte_experimental
+rte_event_eth_rx_adapter_cb_register(uint8_t id,
+				uint16_t eth_dev_id,
+				rte_event_eth_rx_adapter_cb_fn cb_fn,
+				void *cb_arg)
 {
 	struct rte_event_eth_rx_adapter *rx_adapter;
 	struct eth_device_info *dev_info;
diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.h b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
index cf23cde..176f8ca 100644
--- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h
+++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
@@ -173,6 +173,9 @@  struct rte_event_eth_rx_adapter_queue_conf {
 };
 
 /**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
  * A structure used to retrieve statistics for an eth rx adapter instance.
  */
 struct rte_event_eth_rx_adapter_stats {
@@ -201,6 +204,9 @@  struct rte_event_eth_rx_adapter_stats {
 };
 
 /**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
  * Callback function invoked by the SW adapter before it continues
  * to process packets. The callback is passed the size of the enqueue
  * buffer in the SW adapter and the occupancy of the buffer. The
@@ -392,6 +398,9 @@  int rte_event_eth_rx_adapter_queue_del(uint8_t id, uint16_t eth_dev_id,
 int rte_event_eth_rx_adapter_stop(uint8_t id);
 
 /**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
  * Retrieve statistics for an adapter
  *
  * @param id
@@ -404,7 +413,8 @@  int rte_event_eth_rx_adapter_queue_del(uint8_t id, uint16_t eth_dev_id,
  *  - 0: Success, retrieved successfully.
  *  - <0: Error code on failure.
  */
-int rte_event_eth_rx_adapter_stats_get(uint8_t id,
+int __rte_experimental
+rte_event_eth_rx_adapter_stats_get(uint8_t id,
 				struct rte_event_eth_rx_adapter_stats *stats);
 
 /**
@@ -437,6 +447,9 @@  int rte_event_eth_rx_adapter_stats_get(uint8_t id,
 int rte_event_eth_rx_adapter_service_id_get(uint8_t id, uint32_t *service_id);
 
 /**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
  * Register callback to process Rx packets, this is supported for
  * SW based packet transfers.
  * @see rte_event_eth_rx_cb_fn
@@ -453,7 +466,7 @@  int rte_event_eth_rx_adapter_stats_get(uint8_t id,
  *  - 0: Success
  *  - <0: Error code on failure.
  */
-int
+int __rte_experimental
 rte_event_eth_rx_adapter_cb_register(uint8_t id,
 				uint16_t eth_dev_id,
 				rte_event_eth_rx_adapter_cb_fn cb_fn,
diff --git a/lib/librte_eventdev/rte_eventdev_version.map b/lib/librte_eventdev/rte_eventdev_version.map
index 88c3ce5..55c56e3 100644
--- a/lib/librte_eventdev/rte_eventdev_version.map
+++ b/lib/librte_eventdev/rte_eventdev_version.map
@@ -63,7 +63,6 @@  DPDK_17.11 {
 	rte_event_eth_rx_adapter_queue_del;
 	rte_event_eth_rx_adapter_service_id_get;
 	rte_event_eth_rx_adapter_start;
-	rte_event_eth_rx_adapter_stats_get;
 	rte_event_eth_rx_adapter_stats_reset;
 	rte_event_eth_rx_adapter_stop;
 } DPDK_17.08;
@@ -124,3 +123,10 @@  DPDK_19.05 {
 	rte_event_timer_arm_tmo_tick_burst;
 	rte_event_timer_cancel_burst;
 } DPDK_18.05;
+
+EXPERIMENTAL {
+	global:
+
+	rte_event_eth_rx_adapter_cb_register;
+	rte_event_eth_rx_adapter_stats_get;
+};