eventdev: add experimental tag back

Message ID 1555998614-35566-1-git-send-email-nikhil.rao@intel.com (mailing list archive)
State Superseded, archived
Headers
Series 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 23, 2019, 5:50 a.m. UTC
  Add the experimental tag back to the Rx event adapter callback
and the Rx event callback register functions. This patch also
adds the experimental tag in the callback register
function definition and adds the function 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>
---
 lib/librte_eventdev/rte_event_eth_rx_adapter.h | 8 +++++++-
 lib/librte_eventdev/rte_event_eth_rx_adapter.c | 9 +++++----
 lib/librte_eventdev/rte_eventdev_version.map   | 6 ++++++
 3 files changed, 18 insertions(+), 5 deletions(-)
  

Comments

Kevin Traynor April 23, 2019, 10:58 a.m. UTC | #1
On 23/04/2019 06:50, Nikhil Rao wrote:
> Add the experimental tag back to the Rx event adapter callback
> and the Rx event callback register functions. This patch also

You should add an explanation why in the commit message. It is an
unusual thing to do and the other mail thread would be too hard to find.

> adds the experimental tag in the callback register
> function definition and adds the function 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>
> ---
>  lib/librte_eventdev/rte_event_eth_rx_adapter.h | 8 +++++++-
>  lib/librte_eventdev/rte_event_eth_rx_adapter.c | 9 +++++----
>  lib/librte_eventdev/rte_eventdev_version.map   | 6 ++++++
>  3 files changed, 18 insertions(+), 5 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.h b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> index cf23cde..32b52a7 100644
> --- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> +++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> @@ -201,6 +201,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
> @@ -437,6 +440,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 +459,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_event_eth_rx_adapter.c b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
> index 8d178be..e6001e2 100644
> --- a/lib/librte_eventdev/rte_event_eth_rx_adapter.c
> +++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
> @@ -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_eventdev_version.map b/lib/librte_eventdev/rte_eventdev_version.map
> index 88c3ce5..9bfc666 100644
> --- a/lib/librte_eventdev/rte_eventdev_version.map
> +++ b/lib/librte_eventdev/rte_eventdev_version.map
> @@ -124,3 +124,9 @@ 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;
> +};
>
  

Patch

diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.h b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
index cf23cde..32b52a7 100644
--- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h
+++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
@@ -201,6 +201,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
@@ -437,6 +440,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 +459,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_event_eth_rx_adapter.c b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
index 8d178be..e6001e2 100644
--- a/lib/librte_eventdev/rte_event_eth_rx_adapter.c
+++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
@@ -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_eventdev_version.map b/lib/librte_eventdev/rte_eventdev_version.map
index 88c3ce5..9bfc666 100644
--- a/lib/librte_eventdev/rte_eventdev_version.map
+++ b/lib/librte_eventdev/rte_eventdev_version.map
@@ -124,3 +124,9 @@  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;
+};