timer: remove experimental tag for some APIs

Message ID 1599595435-183909-1-git-send-email-erik.g.carrillo@intel.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series timer: remove experimental tag for some APIs |

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Carrillo, Erik G Sept. 8, 2020, 8:03 p.m. UTC
  Some new APIs were added to the timer library in the 19.05 release, and
there have been no changes to their interfaces since then. These
functions can be considered stable enough to remove their 'experimental'
tag.

Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
---
 lib/librte_timer/rte_timer.h           | 32 --------------------------------
 lib/librte_timer/rte_timer_version.map | 16 ++++++++--------
 2 files changed, 8 insertions(+), 40 deletions(-)
  

Comments

Ray Kinsella Oct. 5, 2020, 8:34 a.m. UTC | #1
On 08/09/2020 21:03, Erik Gabriel Carrillo wrote:
> Some new APIs were added to the timer library in the 19.05 release, and
> there have been no changes to their interfaces since then. These
> functions can be considered stable enough to remove their 'experimental'
> tag.
> 
> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
> ---
>  lib/librte_timer/rte_timer.h           | 32 --------------------------------
>  lib/librte_timer/rte_timer_version.map | 16 ++++++++--------
>  2 files changed, 8 insertions(+), 40 deletions(-)
> 

[SNIP]

Acked-by: Ray Kinsella <mdr@ashroe.eu>
  
David Marchand Oct. 5, 2020, 9:33 a.m. UTC | #2
On Tue, Sep 8, 2020 at 10:04 PM Erik Gabriel Carrillo
<erik.g.carrillo@intel.com> wrote:
>
> Some new APIs were added to the timer library in the 19.05 release, and
> there have been no changes to their interfaces since then. These
> functions can be considered stable enough to remove their 'experimental'
> tag.
>
> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>

Acked-by: Ray Kinsella <mdr@ashroe.eu>

Applied, thanks Erik.
  

Patch

diff --git a/lib/librte_timer/rte_timer.h b/lib/librte_timer/rte_timer.h
index c6b3d45..7af8378 100644
--- a/lib/librte_timer/rte_timer.h
+++ b/lib/librte_timer/rte_timer.h
@@ -133,9 +133,6 @@  struct rte_timer
 #endif
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Allocate a timer data instance in shared memory to track a set of pending
  * timer lists.
  *
@@ -147,13 +144,9 @@  struct rte_timer
  *   - 0: Success
  *   - -ENOSPC: maximum number of timer data instances already allocated
  */
-__rte_experimental
 int rte_timer_data_alloc(uint32_t *id_ptr);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Deallocate a timer data instance.
  *
  * @param id
@@ -163,7 +156,6 @@  int rte_timer_data_alloc(uint32_t *id_ptr);
  *   - 0: Success
  *   - -EINVAL: invalid timer data instance identifier
  */
-__rte_experimental
 int rte_timer_data_dealloc(uint32_t id);
 
 /**
@@ -183,12 +175,8 @@  int rte_timer_data_dealloc(uint32_t id);
 int rte_timer_subsystem_init(void);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Free timer subsystem resources.
  */
-__rte_experimental
 void rte_timer_subsystem_finalize(void);
 
 /**
@@ -376,9 +364,6 @@  int rte_timer_manage(void);
 int rte_timer_dump_stats(FILE *f);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * This function is the same as rte_timer_reset(), except that it allows a
  * caller to specify the rte_timer_data instance containing the list to which
  * the timer should be added.
@@ -413,16 +398,12 @@  int rte_timer_dump_stats(FILE *f);
  *   - (-1): Timer is in the RUNNING or CONFIG state.
  *   - -EINVAL: invalid timer_data_id
  */
-__rte_experimental
 int
 rte_timer_alt_reset(uint32_t timer_data_id, struct rte_timer *tim,
 		    uint64_t ticks, enum rte_timer_type type,
 		    unsigned int tim_lcore, rte_timer_cb_t fct, void *arg);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * This function is the same as rte_timer_stop(), except that it allows a
  * caller to specify the rte_timer_data instance containing the list from which
  * this timer should be removed.
@@ -439,7 +420,6 @@  rte_timer_alt_reset(uint32_t timer_data_id, struct rte_timer *tim,
  *   - (-1): The timer is in the RUNNING or CONFIG state.
  *   - -EINVAL: invalid timer_data_id
  */
-__rte_experimental
 int
 rte_timer_alt_stop(uint32_t timer_data_id, struct rte_timer *tim);
 
@@ -449,9 +429,6 @@  rte_timer_alt_stop(uint32_t timer_data_id, struct rte_timer *tim);
 typedef void (*rte_timer_alt_manage_cb_t)(struct rte_timer *tim);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Manage a set of timer lists and execute the specified callback function for
  * all expired timers. This function is similar to rte_timer_manage(), except
  * that it allows a caller to specify the timer_data instance that should
@@ -476,7 +453,6 @@  typedef void (*rte_timer_alt_manage_cb_t)(struct rte_timer *tim);
  *   - 0: success
  *   - -EINVAL: invalid timer_data_id
  */
-__rte_experimental
 int
 rte_timer_alt_manage(uint32_t timer_data_id, unsigned int *poll_lcores,
 		     int n_poll_lcores, rte_timer_alt_manage_cb_t f);
@@ -487,9 +463,6 @@  rte_timer_alt_manage(uint32_t timer_data_id, unsigned int *poll_lcores,
 typedef void (*rte_timer_stop_all_cb_t)(struct rte_timer *tim, void *arg);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Walk the pending timer lists for the specified lcore IDs, and for each timer
  * that is encountered, stop it and call the specified callback function to
  * process it further.
@@ -509,15 +482,11 @@  typedef void (*rte_timer_stop_all_cb_t)(struct rte_timer *tim, void *arg);
  *   - 0: success
  *   - EINVAL: invalid timer_data_id
  */
-__rte_experimental
 int
 rte_timer_stop_all(uint32_t timer_data_id, unsigned int *walk_lcores,
 		   int nb_walk_lcores, rte_timer_stop_all_cb_t f, void *f_arg);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * This function is the same as rte_timer_dump_stats(), except that it allows
  * the caller to specify the rte_timer_data instance that should be used.
  *
@@ -532,7 +501,6 @@  rte_timer_stop_all(uint32_t timer_data_id, unsigned int *walk_lcores,
  *   - 0: success
  *   - -EINVAL: invalid timer_data_id
  */
-__rte_experimental
 int
 rte_timer_alt_dump_stats(uint32_t timer_data_id, FILE *f);
 
diff --git a/lib/librte_timer/rte_timer_version.map b/lib/librte_timer/rte_timer_version.map
index 21e68ea..8021ccf 100644
--- a/lib/librte_timer/rte_timer_version.map
+++ b/lib/librte_timer/rte_timer_version.map
@@ -1,6 +1,12 @@ 
 DPDK_21 {
 	global:
 
+	rte_timer_alt_dump_stats;
+	rte_timer_alt_manage;
+	rte_timer_alt_reset;
+	rte_timer_alt_stop;
+	rte_timer_data_alloc;
+	rte_timer_data_dealloc;
 	rte_timer_dump_stats;
 	rte_timer_init;
 	rte_timer_manage;
@@ -8,7 +14,9 @@  DPDK_21 {
 	rte_timer_reset;
 	rte_timer_reset_sync;
 	rte_timer_stop;
+	rte_timer_stop_all;
 	rte_timer_stop_sync;
+	rte_timer_subsystem_finalize;
 	rte_timer_subsystem_init;
 
 	local: *;
@@ -17,13 +25,5 @@  DPDK_21 {
 EXPERIMENTAL {
 	global:
 
-	rte_timer_alt_dump_stats;
-	rte_timer_alt_manage;
-	rte_timer_alt_reset;
-	rte_timer_alt_stop;
-	rte_timer_data_alloc;
-	rte_timer_data_dealloc;
 	rte_timer_next_ticks;
-	rte_timer_stop_all;
-	rte_timer_subsystem_finalize;
 };