Skip to contentSkip to conversation

telemetry: promote experimental API to stable

PATCH Applied Stephen Hemminger 3 participants 3 messages Sep 2 – Sep 16

lore
Share & tools
lore

Stephen Hemminger

author
#0 lore raw

PATCH 1/1 telemetry: promote experimental API to stable

The remaining experimental telemetry functions have been present without interface changes for several releases: the hexadecimal helpers rte_tel_data_add_array_uint_hex() and rte_tel_data_add_dict_uint_hex() since v23.03, and rte_telemetry_register_cmd_arg() since v24.11. Promote all three to the stable ABI.

Signed-off-by Stephen Hemminger <[email protected]>
---
 doc/guides/rel_notes/release_26_11.rst | 6 ++++++
 lib/telemetry/rte_telemetry.h          | 3 ---
 lib/telemetry/telemetry.c              | 2 +-
 lib/telemetry/telemetry_data.c         | 4 ++--
 4 files changed, 9 insertions(+), 6 deletions(-)
doc/guides/rel_notes/release_26_11.rst +6 -0
index 87c7e81bde..edca1f445c 100644
@@ -95,6 +95,12 @@ API Changes
    Also, make sure to start the actual text at the margin.
    =======================================================
 
+* telemetry: Promoted the following functions to stable:
+
+  * ``rte_tel_data_add_array_uint_hex``
+  * ``rte_tel_data_add_dict_uint_hex``
+  * ``rte_telemetry_register_cmd_arg``
+
 
 ABI Changes
 -----------
lib/telemetry/rte_telemetry.h +0 -3
index 0a58e518f7..f5b2aa1415 100644
@@ -174,7 +174,6 @@ rte_tel_data_add_array_container(struct rte_tel_data *d,
  * @return
  *   0 on success, negative errno on error.
  */
-__rte_experimental
 int
 rte_tel_data_add_array_uint_hex(struct rte_tel_data *d, uint64_t val,
 		uint8_t display_bitwidth);

@@ -276,7 +275,6 @@ rte_tel_data_add_dict_container(struct rte_tel_data *d, const char *name,
  * @return
  *   0 on success, negative errno on error.
  */
-__rte_experimental
 int
 rte_tel_data_add_dict_uint_hex(struct rte_tel_data *d, const char *name,
 		uint64_t val, uint8_t display_bitwidth);

@@ -364,7 +362,6 @@ rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);
  * @return
  *   -ENOMEM for mem allocation failure.
  */
-__rte_experimental
 int
 rte_telemetry_register_cmd_arg(const char *cmd, telemetry_arg_cb fn, void *arg, const char *help);
lib/telemetry/telemetry.c +1 -1
index e591c1e283..379dbf4ce3 100644
@@ -122,7 +122,7 @@ rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
 	return register_cmd(cmd, help, fn, NULL, NULL);
 }
 
-RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_telemetry_register_cmd_arg, 24.11)
+RTE_EXPORT_SYMBOL(rte_telemetry_register_cmd_arg)
 int
 rte_telemetry_register_cmd_arg(const char *cmd, telemetry_arg_cb fn, void *arg, const char *help)
 {
lib/telemetry/telemetry_data.c +2 -2
index 0a006559ab..8e0f4c515b 100644
@@ -124,7 +124,7 @@ rte_tel_uint_to_hex_encoded_str(char *buf, size_t buf_len, uint64_t val,
 	return len < (int)buf_len ? 0 : -EINVAL;
 }
 
-RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_tel_data_add_array_uint_hex, 23.03)
+RTE_EXPORT_SYMBOL(rte_tel_data_add_array_uint_hex)
 int
 rte_tel_data_add_array_uint_hex(struct rte_tel_data *d, uint64_t val,
 				uint8_t display_bitwidth)

@@ -248,7 +248,7 @@ rte_tel_data_add_dict_container(struct rte_tel_data *d, const char *name,
 	return bytes < RTE_TEL_MAX_STRING_LEN ? 0 : E2BIG;
 }
 
-RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_tel_data_add_dict_uint_hex, 23.03)
+RTE_EXPORT_SYMBOL(rte_tel_data_add_dict_uint_hex)
 int
 rte_tel_data_add_dict_uint_hex(struct rte_tel_data *d, const char *name,
 			       uint64_t val, uint8_t display_bitwidth)
Signature · 1 line
2.53.0
Acked-by on v1 1/1
#1 lore raw
Quoted 6 lines · Stephen Hemminger

The remaining experimental telemetry functions have been present without interface changes for several releases: the hexadecimal helpers rte_tel_data_add_array_uint_hex() and rte_tel_data_add_dict_uint_hex() since v23.03, and rte_telemetry_register_cmd_arg() since v24.11. Promote all three to the stable ABI.

Quoted 8 lines
Signed-off-by Stephen Hemminger <[email protected]>
---
 doc/guides/rel_notes/release_26_11.rst | 6 ++++++
 lib/telemetry/rte_telemetry.h          | 3 ---
 lib/telemetry/telemetry.c              | 2 +-
 lib/telemetry/telemetry_data.c         | 4 ++--
 4 files changed, 9 insertions(+), 6 deletions(-)
Acked-by Bruce Richardson <[email protected]>
Applied
#2 lore raw
Quoted 10 lines · Bruce Richardson
Quoted 7 lines · Stephen Hemminger

The remaining experimental telemetry functions have been present without interface changes for several releases: the hexadecimal helpers rte_tel_data_add_array_uint_hex() and rte_tel_data_add_dict_uint_hex() since v23.03, and rte_telemetry_register_cmd_arg() since v24.11. Promote all three to the stable ABI.

Signed-off-by Stephen Hemminger <[email protected]>
Acked-by Bruce Richardson <[email protected]>

Applied, thanks.

Signature · 1 line
David Marchand