diff mbox series

[RFC,1/7] telemetry: rename unsigned 64-bit enum value to uint

Message ID 20221213182730.97065-2-bruce.richardson@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series Standardize telemetry int types |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson Dec. 13, 2022, 6:27 p.m. UTC 
  For telemetry data, rather than having unsigned 64-bit values and signed
32-bit values, we want to just have unsigned and signed values, each
stored with the max bit-width i.e. 64-bits. To that end, we rename the
U64 enum entry to "UINT" to have a more generic name

For backward API-level compatibility, we can use a macro to alias the
old name to the new.

Suggested-by: Morten Brørup <mb@smartsharesystems.com>
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 app/test/test_telemetry_data.c               | 10 +++++-----
 drivers/net/cnxk/cnxk_ethdev_sec_telemetry.c |  4 ++--
 drivers/net/cnxk/cnxk_ethdev_telemetry.c     |  2 +-
 lib/cryptodev/rte_cryptodev.c                |  2 +-
 lib/ethdev/rte_ethdev.c                      |  2 +-
 lib/ipsec/ipsec_telemetry.c                  |  2 +-
 lib/security/rte_security.c                  |  4 ++--
 lib/telemetry/rte_telemetry.h                |  6 ++++--
 lib/telemetry/telemetry.c                    |  4 ++--
 lib/telemetry/telemetry_data.c               |  4 ++--
 10 files changed, 21 insertions(+), 19 deletions(-)

Comments

Tyler Retzlaff Dec. 14, 2022, 5:30 p.m. UTC | #1 
On Tue, Dec 13, 2022 at 06:27:24PM +0000, Bruce Richardson wrote:
> For telemetry data, rather than having unsigned 64-bit values and signed
> 32-bit values, we want to just have unsigned and signed values, each
> stored with the max bit-width i.e. 64-bits. To that end, we rename the
> U64 enum entry to "UINT" to have a more generic name
> 
> For backward API-level compatibility, we can use a macro to alias the
> old name to the new.
> 
> Suggested-by: Morten Brørup <mb@smartsharesystems.com>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> diff --git a/lib/telemetry/telemetry_data.c b/lib/telemetry/telemetry_data.c
> index 34366ecee3..3c996484ec 100644
> --- a/lib/telemetry/telemetry_data.c
> +++ b/lib/telemetry/telemetry_data.c
> @@ -18,7 +18,7 @@ rte_tel_data_start_array(struct rte_tel_data *d, enum rte_tel_value_type type)
>  	enum tel_container_types array_types[] = {
>  			RTE_TEL_ARRAY_STRING, /* RTE_TEL_STRING_VAL = 0 */
>  			RTE_TEL_ARRAY_INT,    /* RTE_TEL_INT_VAL = 1 */
> -			RTE_TEL_ARRAY_U64,    /* RTE_TEL_u64_VAL = 2 */
> +			RTE_TEL_ARRAY_U64,    /* RTE_TEL_UINT_VAL = 2 */
                        ^^^^^^^^^^^^^^^^^

is this supposed to be RTE_TEL_UINT_VAL?

>  			RTE_TEL_ARRAY_CONTAINER, /* RTE_TEL_CONTAINER = 3 */
>  	};
>  	d->type = array_types[type];
> @@ -173,7 +173,7 @@ rte_tel_data_add_dict_u64(struct rte_tel_data *d,
>  		return -EINVAL;
>  
>  	d->data_len++;
> -	e->type = RTE_TEL_U64_VAL;
> +	e->type = RTE_TEL_UINT_VAL;
>  	e->value.u64val = val;
>  	const size_t bytes = strlcpy(e->name, name, RTE_TEL_MAX_STRING_LEN);
>  	return bytes < RTE_TEL_MAX_STRING_LEN ? 0 : E2BIG;
> -- 
> 2.34.1
Bruce Richardson Dec. 15, 2022, 9:41 a.m. UTC | #2 
On Wed, Dec 14, 2022 at 09:30:05AM -0800, Tyler Retzlaff wrote:
> On Tue, Dec 13, 2022 at 06:27:24PM +0000, Bruce Richardson wrote:
> > For telemetry data, rather than having unsigned 64-bit values and signed
> > 32-bit values, we want to just have unsigned and signed values, each
> > stored with the max bit-width i.e. 64-bits. To that end, we rename the
> > U64 enum entry to "UINT" to have a more generic name
> > 
> > For backward API-level compatibility, we can use a macro to alias the
> > old name to the new.
> > 
> > Suggested-by: Morten Brørup <mb@smartsharesystems.com>
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > ---
> > diff --git a/lib/telemetry/telemetry_data.c b/lib/telemetry/telemetry_data.c
> > index 34366ecee3..3c996484ec 100644
> > --- a/lib/telemetry/telemetry_data.c
> > +++ b/lib/telemetry/telemetry_data.c
> > @@ -18,7 +18,7 @@ rte_tel_data_start_array(struct rte_tel_data *d, enum rte_tel_value_type type)
> >  	enum tel_container_types array_types[] = {
> >  			RTE_TEL_ARRAY_STRING, /* RTE_TEL_STRING_VAL = 0 */
> >  			RTE_TEL_ARRAY_INT,    /* RTE_TEL_INT_VAL = 1 */
> > -			RTE_TEL_ARRAY_U64,    /* RTE_TEL_u64_VAL = 2 */
> > +			RTE_TEL_ARRAY_U64,    /* RTE_TEL_UINT_VAL = 2 */
>                         ^^^^^^^^^^^^^^^^^
> 
> is this supposed to be RTE_TEL_UINT_VAL?
>
No, only the comment is to be changed in this line. The ARRAY_ values are
different and are internal only. Those are renamed by a later patch in the
series.

/Bruce
Tyler Retzlaff Dec. 15, 2022, 5:53 p.m. UTC | #3 
On Thu, Dec 15, 2022 at 09:41:38AM +0000, Bruce Richardson wrote:
> On Wed, Dec 14, 2022 at 09:30:05AM -0800, Tyler Retzlaff wrote:
> > On Tue, Dec 13, 2022 at 06:27:24PM +0000, Bruce Richardson wrote:
> > > For telemetry data, rather than having unsigned 64-bit values and signed
> > > 32-bit values, we want to just have unsigned and signed values, each
> > > stored with the max bit-width i.e. 64-bits. To that end, we rename the
> > > U64 enum entry to "UINT" to have a more generic name
> > > 
> > > For backward API-level compatibility, we can use a macro to alias the
> > > old name to the new.
> > > 
> > > Suggested-by: Morten Brørup <mb@smartsharesystems.com>
> > > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > > ---
> > > diff --git a/lib/telemetry/telemetry_data.c b/lib/telemetry/telemetry_data.c
> > > index 34366ecee3..3c996484ec 100644
> > > --- a/lib/telemetry/telemetry_data.c
> > > +++ b/lib/telemetry/telemetry_data.c
> > > @@ -18,7 +18,7 @@ rte_tel_data_start_array(struct rte_tel_data *d, enum rte_tel_value_type type)
> > >  	enum tel_container_types array_types[] = {
> > >  			RTE_TEL_ARRAY_STRING, /* RTE_TEL_STRING_VAL = 0 */
> > >  			RTE_TEL_ARRAY_INT,    /* RTE_TEL_INT_VAL = 1 */
> > > -			RTE_TEL_ARRAY_U64,    /* RTE_TEL_u64_VAL = 2 */
> > > +			RTE_TEL_ARRAY_U64,    /* RTE_TEL_UINT_VAL = 2 */
> >                         ^^^^^^^^^^^^^^^^^
> > 
> > is this supposed to be RTE_TEL_UINT_VAL?
> >
> No, only the comment is to be changed in this line. The ARRAY_ values are
> different and are internal only. Those are renamed by a later patch in the
> series.

yep, sorry about that i noticed it when i looked at later patches.

> 
> /Bruce
diff mbox series

Patch

diff --git a/app/test/test_telemetry_data.c b/app/test/test_telemetry_data.c
index d92667a527..24a2035b61 100644
--- a/app/test/test_telemetry_data.c
+++ b/app/test/test_telemetry_data.c
@@ -283,7 +283,7 @@  test_case_array_u64(void)
 {
 	int i;
 
-	rte_tel_data_start_array(&response_data, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(&response_data, RTE_TEL_UINT_VAL);
 	for (i = 0; i < 5; i++)
 		rte_tel_data_add_array_u64(&response_data, i);
 	return CHECK_OUTPUT("[0,1,2,3,4]");
@@ -310,10 +310,10 @@  test_dict_with_array_u64_values(void)
 	int i;
 
 	struct rte_tel_data *child_data = rte_tel_data_alloc();
-	rte_tel_data_start_array(child_data, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(child_data, RTE_TEL_UINT_VAL);
 
 	struct rte_tel_data *child_data2 = rte_tel_data_alloc();
-	rte_tel_data_start_array(child_data2, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(child_data2, RTE_TEL_UINT_VAL);
 
 	rte_tel_data_start_dict(&response_data);
 
@@ -336,10 +336,10 @@  test_array_with_array_u64_values(void)
 	int i;
 
 	struct rte_tel_data *child_data = rte_tel_data_alloc();
-	rte_tel_data_start_array(child_data, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(child_data, RTE_TEL_UINT_VAL);
 
 	struct rte_tel_data *child_data2 = rte_tel_data_alloc();
-	rte_tel_data_start_array(child_data2, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(child_data2, RTE_TEL_UINT_VAL);
 
 	rte_tel_data_start_array(&response_data, RTE_TEL_CONTAINER);
 
diff --git a/drivers/net/cnxk/cnxk_ethdev_sec_telemetry.c b/drivers/net/cnxk/cnxk_ethdev_sec_telemetry.c
index 8e6277cbcd..59f0cce5ab 100644
--- a/drivers/net/cnxk/cnxk_ethdev_sec_telemetry.c
+++ b/drivers/net/cnxk/cnxk_ethdev_sec_telemetry.c
@@ -94,7 +94,7 @@  copy_outb_sa_10k(struct rte_tel_data *d, uint32_t i, void *sa)
 		return -ENOMEM;
 	}
 
-	rte_tel_data_start_array(outer_hdr, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(outer_hdr, RTE_TEL_UINT_VAL);
 
 	for (j = 0; j < RTE_DIM(out_sa->outer_hdr.ipv6.src_addr); j++)
 		rte_tel_data_add_array_u64(outer_hdr,
@@ -167,7 +167,7 @@  copy_inb_sa_10k(struct rte_tel_data *d, uint32_t i, void *sa)
 		return -ENOMEM;
 	}
 
-	rte_tel_data_start_array(outer_hdr, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(outer_hdr, RTE_TEL_UINT_VAL);
 
 	for (j = 0; j < RTE_DIM(in_sa->outer_hdr.ipv6.src_addr); j++)
 		rte_tel_data_add_array_u64(outer_hdr,
diff --git a/drivers/net/cnxk/cnxk_ethdev_telemetry.c b/drivers/net/cnxk/cnxk_ethdev_telemetry.c
index 180108ab9c..5db973d620 100644
--- a/drivers/net/cnxk/cnxk_ethdev_telemetry.c
+++ b/drivers/net/cnxk/cnxk_ethdev_telemetry.c
@@ -52,7 +52,7 @@  ethdev_tel_handle_info(const char *cmd __rte_unused,
 	i_data = rte_tel_data_alloc();
 	if (i_data == NULL)
 		return -ENOMEM;
-	rte_tel_data_start_array(i_data, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(i_data, RTE_TEL_UINT_VAL);
 
 	for (i = 0; i < RTE_MAX_ETHPORTS; i++) {
 		/* Skip if port is unused */
diff --git a/lib/cryptodev/rte_cryptodev.c b/lib/cryptodev/rte_cryptodev.c
index 2165a0688c..79ea958db4 100644
--- a/lib/cryptodev/rte_cryptodev.c
+++ b/lib/cryptodev/rte_cryptodev.c
@@ -2744,7 +2744,7 @@  crypto_caps_array(struct rte_tel_data *d,
 	uint64_t caps_val[CRYPTO_CAPS_SZ];
 	unsigned int i = 0, j;
 
-	rte_tel_data_start_array(d, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(d, RTE_TEL_UINT_VAL);
 
 	while ((dev_caps = &capabilities[i++])->op !=
 			RTE_CRYPTO_OP_TYPE_UNDEFINED) {
diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index 5d5e18db1e..28028e5de5 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -5818,7 +5818,7 @@  eth_dev_add_port_queue_stats(struct rte_tel_data *d, uint64_t *q_stats,
 	struct rte_tel_data *q_data = rte_tel_data_alloc();
 	if (q_data == NULL)
 		return;
-	rte_tel_data_start_array(q_data, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(q_data, RTE_TEL_UINT_VAL);
 	for (q = 0; q < RTE_ETHDEV_QUEUE_STAT_CNTRS; q++)
 		rte_tel_data_add_array_u64(q_data, q_stats[q]);
 	rte_tel_data_add_dict_container(d, stat_name, q_data, 0);
diff --git a/lib/ipsec/ipsec_telemetry.c b/lib/ipsec/ipsec_telemetry.c
index cfebf454d6..b184e8df99 100644
--- a/lib/ipsec/ipsec_telemetry.c
+++ b/lib/ipsec/ipsec_telemetry.c
@@ -22,7 +22,7 @@  handle_telemetry_cmd_ipsec_sa_list(const char *cmd __rte_unused,
 		struct rte_tel_data *data)
 {
 	struct ipsec_telemetry_entry *entry;
-	rte_tel_data_start_array(data, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(data, RTE_TEL_UINT_VAL);
 
 	LIST_FOREACH(entry, &ipsec_telemetry_list, next) {
 		const struct rte_ipsec_sa *sa = entry->sa;
diff --git a/lib/security/rte_security.c b/lib/security/rte_security.c
index 29af5f3e4b..68063f6450 100644
--- a/lib/security/rte_security.c
+++ b/lib/security/rte_security.c
@@ -316,7 +316,7 @@  crypto_caps_array(struct rte_tel_data *d,
 	uint64_t caps_val[CRYPTO_CAPS_SZ];
 	unsigned int i = 0, j;
 
-	rte_tel_data_start_array(d, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(d, RTE_TEL_UINT_VAL);
 
 	while ((dev_caps = &capabilities[i++])->op !=
 	   RTE_CRYPTO_OP_TYPE_UNDEFINED) {
@@ -341,7 +341,7 @@  sec_caps_array(struct rte_tel_data *d,
 	uint64_t caps_val[SEC_CAPS_SZ];
 	unsigned int i = 0, j;
 
-	rte_tel_data_start_array(d, RTE_TEL_U64_VAL);
+	rte_tel_data_start_array(d, RTE_TEL_UINT_VAL);
 
 	while ((dev_caps = &capabilities[i++])->action !=
 	   RTE_SECURITY_ACTION_TYPE_NONE) {
diff --git a/lib/telemetry/rte_telemetry.h b/lib/telemetry/rte_telemetry.h
index d9918c4e96..c2ad65effe 100644
--- a/lib/telemetry/rte_telemetry.h
+++ b/lib/telemetry/rte_telemetry.h
@@ -43,10 +43,12 @@  struct rte_tel_data;
 enum rte_tel_value_type {
 	RTE_TEL_STRING_VAL, /** a string value */
 	RTE_TEL_INT_VAL,    /** a signed 32-bit int value */
-	RTE_TEL_U64_VAL,    /** an unsigned 64-bit int value */
+	RTE_TEL_UINT_VAL,  /** an unsigned 64-bit int value */
 	RTE_TEL_CONTAINER, /** a container struct */
 };
 
+#define RTE_TEL_U64_VAL RTE_TEL_UINT_VAL
+
 /**
  * Start an array of the specified type for returning from a callback
  *
@@ -121,7 +123,7 @@  rte_tel_data_add_array_int(struct rte_tel_data *d, int x);
 /**
  * Add a uint64_t to an array.
  * The array must have been started by rte_tel_data_start_array() with
- * RTE_TEL_U64_VAL as the type parameter.
+ * RTE_TEL_UINT_VAL as the type parameter.
  *
  * @param d
  *   The data structure passed to the callback
diff --git a/lib/telemetry/telemetry.c b/lib/telemetry/telemetry.c
index 8fbb4f3060..75957fe0b1 100644
--- a/lib/telemetry/telemetry.c
+++ b/lib/telemetry/telemetry.c
@@ -201,7 +201,7 @@  container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
 						buf_len, used,
 						v->name, v->value.ival);
 				break;
-			case RTE_TEL_U64_VAL:
+			case RTE_TEL_UINT_VAL:
 				used = rte_tel_json_add_obj_u64(out_buf,
 						buf_len, used,
 						v->name, v->value.u64val);
@@ -268,7 +268,7 @@  output_json(const char *cmd, const struct rte_tel_data *d, int s)
 						buf_len, used,
 						v->name, v->value.ival);
 				break;
-			case RTE_TEL_U64_VAL:
+			case RTE_TEL_UINT_VAL:
 				used = rte_tel_json_add_obj_u64(cb_data_buf,
 						buf_len, used,
 						v->name, v->value.u64val);
diff --git a/lib/telemetry/telemetry_data.c b/lib/telemetry/telemetry_data.c
index 34366ecee3..3c996484ec 100644
--- a/lib/telemetry/telemetry_data.c
+++ b/lib/telemetry/telemetry_data.c
@@ -18,7 +18,7 @@  rte_tel_data_start_array(struct rte_tel_data *d, enum rte_tel_value_type type)
 	enum tel_container_types array_types[] = {
 			RTE_TEL_ARRAY_STRING, /* RTE_TEL_STRING_VAL = 0 */
 			RTE_TEL_ARRAY_INT,    /* RTE_TEL_INT_VAL = 1 */
-			RTE_TEL_ARRAY_U64,    /* RTE_TEL_u64_VAL = 2 */
+			RTE_TEL_ARRAY_U64,    /* RTE_TEL_UINT_VAL = 2 */
 			RTE_TEL_ARRAY_CONTAINER, /* RTE_TEL_CONTAINER = 3 */
 	};
 	d->type = array_types[type];
@@ -173,7 +173,7 @@  rte_tel_data_add_dict_u64(struct rte_tel_data *d,
 		return -EINVAL;
 
 	d->data_len++;
-	e->type = RTE_TEL_U64_VAL;
+	e->type = RTE_TEL_UINT_VAL;
 	e->value.u64val = val;
 	const size_t bytes = strlcpy(e->name, name, RTE_TEL_MAX_STRING_LEN);
 	return bytes < RTE_TEL_MAX_STRING_LEN ? 0 : E2BIG;