diff mbox series

[v2,1/2] libtraceeval: Remove need to use TRACEEVAL_TYPE_NONE in keys and vals

Message ID 20231003140802.1139616-2-rostedt@goodmis.org (mailing list archive)
State Accepted
Headers show
Series libtraceeval: Remove the need of TRACEEVAL_TYPE_NONE | expand

Commit Message

Steven Rostedt Oct. 3, 2023, 2:08 p.m. UTC 
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

Currently, the size of the keys and vals are determined by the
requirement that the traceeval_type array end with an empty element of
type TRACEEVAL_TYPE_NONE.

To make the API be able to handle changes of the size of that structure,
the traceeval_init() was converted to a macro to pass in the sizeof of
that structure. This also means it can calculate the size of the array
with the TRACEEVAL_ARRAY_SIZE() macro.

Remove the need to have the initialization of traceeval keys and vals
have to add the NONE element at the end. It can still do so and this
will work just the same (the size will be determined by either the size
passed in or the first NONE element, which ever is smaller).

Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
 include/traceeval-hist.h | 11 +++++++++--
 src/histograms.c         | 23 +++++++++++++----------
 2 files changed, 22 insertions(+), 12 deletions(-)

Comments

Ross Zwisler Oct. 3, 2023, 3:39 p.m. UTC | #1 
On Tue, Oct 03, 2023 at 10:08:01AM -0400, Steven Rostedt wrote:
> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
> 
> Currently, the size of the keys and vals are determined by the
> requirement that the traceeval_type array end with an empty element of
> type TRACEEVAL_TYPE_NONE.
> 
> To make the API be able to handle changes of the size of that structure,
> the traceeval_init() was converted to a macro to pass in the sizeof of
> that structure. This also means it can calculate the size of the array
> with the TRACEEVAL_ARRAY_SIZE() macro.
> 
> Remove the need to have the initialization of traceeval keys and vals
> have to add the NONE element at the end. It can still do so and this
> will work just the same (the size will be determined by either the size
> passed in or the first NONE element, which ever is smaller).
> 
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

IMO trying to support both types of inputs (ending with TRACEEVAL_TYPE_NONE
and just relying on the element count) is probably bad long term because one
or the other will break and we may not notice, and we'll have to make sure we
keep up both.

As we don't really have users yet (do we?) can we just move fully over to the
count way and give on the other?

In either case, we probably need to still update the comments above
type_alloc(), traceeval_init_data_size() and traceeval_insert_size() which
talk about how we rely on TRACEEVAL_TYPE_NONE to terminate our element lists.

What we have here though is correct:
Reviewed-by: Ross Zwisler <zwisler@google.com>

> ---
>  include/traceeval-hist.h | 11 +++++++++--
>  src/histograms.c         | 23 +++++++++++++----------
>  2 files changed, 22 insertions(+), 12 deletions(-)
> 
> diff --git a/include/traceeval-hist.h b/include/traceeval-hist.h
> index 65a905034773..cd089b28b852 100644
> --- a/include/traceeval-hist.h
> +++ b/include/traceeval-hist.h
> @@ -171,12 +171,19 @@ struct traceeval;
>  
>  /* Histogram interfaces */
>  
> -#define traceeval_init(keys, vals) \
> -	traceeval_init_data_size(keys, vals, sizeof(struct traceeval_type), \
> +#define traceeval_init(keys, vals)					\
> +	traceeval_init_size(keys, vals,					\
> +			    TRACEEVAL_ARRAY_SIZE(keys),			\
> +			    (void *)vals == NULL ?  0 : TRACEEVAL_ARRAY_SIZE(vals))
> +
> +#define traceeval_init_size(keys, vals, nr_keys, nr_vals)		\
> +	traceeval_init_data_size(keys, vals, nr_keys, nr_vals,		\
> +				 sizeof(struct traceeval_type),		\
>  				 sizeof(struct traceeval_data))
>  
>  struct traceeval *traceeval_init_data_size(struct traceeval_type *keys,
>  					   struct traceeval_type *vals,
> +					   size_t nr_keys, size_t nr_vals,
>  					   size_t sizeof_type, size_t sizeof_data);
>  
>  void traceeval_release(struct traceeval *teval);
> diff --git a/src/histograms.c b/src/histograms.c
> index d8ee373be705..0f20d76b5e04 100644
> --- a/src/histograms.c
> +++ b/src/histograms.c
> @@ -151,7 +151,8 @@ static void type_release(struct traceeval_type *defs, size_t len)
>   * Returns the size of the array pointed to by @copy, or -1 on error.
>   */
>  static size_t type_alloc(const struct traceeval_type *defs,
> -			 struct traceeval_type **copy)
> +			 struct traceeval_type **copy,
> +			 size_t cnt)
>  {
>  	struct traceeval_type *new_defs = NULL;
>  	size_t size;
> @@ -162,7 +163,8 @@ static size_t type_alloc(const struct traceeval_type *defs,
>  	if (!defs)
>  		return 0;
>  
> -	for (size = 0; defs && defs[size].type != TRACEEVAL_TYPE_NONE; size++)
> +	for (size = 0; defs && size < cnt &&
> +		     defs[size].type != TRACEEVAL_TYPE_NONE; size++)
>  		;
>  
>  	if (!size)
> @@ -198,9 +200,9 @@ fail:
>  	return -1;
>  }
>  
> -static int check_keys(struct traceeval_type *keys)
> +static int check_keys(struct traceeval_type *keys, int cnt)
>  {
> -	for (int i = 0; keys[i].type != TRACEEVAL_TYPE_NONE; i++) {
> +	for (int i = 0; i < cnt && keys[i].type != TRACEEVAL_TYPE_NONE; i++) {
>  		/* Define this as a key */
>  		keys[i].flags |= TRACEEVAL_FL_KEY;
>  		keys[i].flags &= ~TRACEEVAL_FL_VALUE;
> @@ -220,9 +222,9 @@ static int check_keys(struct traceeval_type *keys)
>  	return 0;
>  }
>  
> -static int check_vals(struct traceeval_type *vals)
> +static int check_vals(struct traceeval_type *vals, int cnt)
>  {
> -	for (int i = 0; vals[i].type != TRACEEVAL_TYPE_NONE; i++) {
> +	for (int i = 0; i < cnt && vals[i].type != TRACEEVAL_TYPE_NONE; i++) {
>  		/* Define this as a value */
>  		vals[i].flags |= TRACEEVAL_FL_VALUE;
>  		vals[i].flags &= ~TRACEEVAL_FL_KEY;
> @@ -269,6 +271,7 @@ static int check_vals(struct traceeval_type *vals)
>   */
>  struct traceeval *traceeval_init_data_size(struct traceeval_type *keys,
>  					   struct traceeval_type *vals,
> +					   size_t nr_keys, size_t nr_vals,
>  					   size_t sizeof_type, size_t sizeof_data)
>  {
>  	struct traceeval *teval;
> @@ -290,25 +293,25 @@ struct traceeval *traceeval_init_data_size(struct traceeval_type *keys,
>  		goto fail;
>  	}
>  
> -	ret = check_keys(keys);
> +	ret = check_keys(keys, nr_keys);
>  	if (ret < 0)
>  		goto fail_release;
>  
>  	if (vals) {
> -		ret = check_vals(vals);
> +		ret = check_vals(vals, nr_vals);
>  		if (ret < 0)
>  			goto fail_release;
>  	}
>  
>  	/* alloc key types */
> -	teval->nr_key_types = type_alloc(keys, &teval->key_types);
> +	teval->nr_key_types = type_alloc(keys, &teval->key_types, nr_keys);
>  	if (teval->nr_key_types <= 0) {
>  		err_msg = "Failed to allocate user defined keys";
>  		goto fail_release;
>  	}
>  
>  	/* alloc val types */
> -	teval->nr_val_types = type_alloc(vals, &teval->val_types);
> +	teval->nr_val_types = type_alloc(vals, &teval->val_types, nr_vals);
>  	if (teval->nr_val_types < 0) {
>  		err_msg = "Failed to allocate user defined values";
>  		goto fail_release;
> -- 
> 2.40.1
>
Steven Rostedt Oct. 3, 2023, 3:44 p.m. UTC | #2 
On Tue, 3 Oct 2023 09:39:20 -0600
Ross Zwisler <zwisler@google.com> wrote:

> IMO trying to support both types of inputs (ending with TRACEEVAL_TYPE_NONE
> and just relying on the element count) is probably bad long term because one
> or the other will break and we may not notice, and we'll have to make sure we
> keep up both.

I plan on really only supporting the one type (defined size), the
TRACEEVAL_TYPE_NONE will not be shown in the man pages. The reason I want
to keep them is mostly for debugging (can add this to test issues and what not).

So yeah, I agree we only want to support one, and we are going to do that,
but the other will still be there "hidden" from the users ;-)

> 
> As we don't really have users yet (do we?) can we just move fully over to the
> count way and give on the other?
> 
> In either case, we probably need to still update the comments above
> type_alloc(), traceeval_init_data_size() and traceeval_insert_size() which
> talk about how we rely on TRACEEVAL_TYPE_NONE to terminate our element lists.

Will do that in another patch. But right now I'm working on the man pages,
and that's really where I expect people to get their information on how to
use the library.

> 
> What we have here though is correct:
> Reviewed-by: Ross Zwisler <zwisler@google.com>

Thanks,

-- Steve
diff mbox series

Patch

diff --git a/include/traceeval-hist.h b/include/traceeval-hist.h
index 65a905034773..cd089b28b852 100644
--- a/include/traceeval-hist.h
+++ b/include/traceeval-hist.h
@@ -171,12 +171,19 @@  struct traceeval;
 
 /* Histogram interfaces */
 
-#define traceeval_init(keys, vals) \
-	traceeval_init_data_size(keys, vals, sizeof(struct traceeval_type), \
+#define traceeval_init(keys, vals)					\
+	traceeval_init_size(keys, vals,					\
+			    TRACEEVAL_ARRAY_SIZE(keys),			\
+			    (void *)vals == NULL ?  0 : TRACEEVAL_ARRAY_SIZE(vals))
+
+#define traceeval_init_size(keys, vals, nr_keys, nr_vals)		\
+	traceeval_init_data_size(keys, vals, nr_keys, nr_vals,		\
+				 sizeof(struct traceeval_type),		\
 				 sizeof(struct traceeval_data))
 
 struct traceeval *traceeval_init_data_size(struct traceeval_type *keys,
 					   struct traceeval_type *vals,
+					   size_t nr_keys, size_t nr_vals,
 					   size_t sizeof_type, size_t sizeof_data);
 
 void traceeval_release(struct traceeval *teval);
diff --git a/src/histograms.c b/src/histograms.c
index d8ee373be705..0f20d76b5e04 100644
--- a/src/histograms.c
+++ b/src/histograms.c
@@ -151,7 +151,8 @@  static void type_release(struct traceeval_type *defs, size_t len)
  * Returns the size of the array pointed to by @copy, or -1 on error.
  */
 static size_t type_alloc(const struct traceeval_type *defs,
-			 struct traceeval_type **copy)
+			 struct traceeval_type **copy,
+			 size_t cnt)
 {
 	struct traceeval_type *new_defs = NULL;
 	size_t size;
@@ -162,7 +163,8 @@  static size_t type_alloc(const struct traceeval_type *defs,
 	if (!defs)
 		return 0;
 
-	for (size = 0; defs && defs[size].type != TRACEEVAL_TYPE_NONE; size++)
+	for (size = 0; defs && size < cnt &&
+		     defs[size].type != TRACEEVAL_TYPE_NONE; size++)
 		;
 
 	if (!size)
@@ -198,9 +200,9 @@  fail:
 	return -1;
 }
 
-static int check_keys(struct traceeval_type *keys)
+static int check_keys(struct traceeval_type *keys, int cnt)
 {
-	for (int i = 0; keys[i].type != TRACEEVAL_TYPE_NONE; i++) {
+	for (int i = 0; i < cnt && keys[i].type != TRACEEVAL_TYPE_NONE; i++) {
 		/* Define this as a key */
 		keys[i].flags |= TRACEEVAL_FL_KEY;
 		keys[i].flags &= ~TRACEEVAL_FL_VALUE;
@@ -220,9 +222,9 @@  static int check_keys(struct traceeval_type *keys)
 	return 0;
 }
 
-static int check_vals(struct traceeval_type *vals)
+static int check_vals(struct traceeval_type *vals, int cnt)
 {
-	for (int i = 0; vals[i].type != TRACEEVAL_TYPE_NONE; i++) {
+	for (int i = 0; i < cnt && vals[i].type != TRACEEVAL_TYPE_NONE; i++) {
 		/* Define this as a value */
 		vals[i].flags |= TRACEEVAL_FL_VALUE;
 		vals[i].flags &= ~TRACEEVAL_FL_KEY;
@@ -269,6 +271,7 @@  static int check_vals(struct traceeval_type *vals)
  */
 struct traceeval *traceeval_init_data_size(struct traceeval_type *keys,
 					   struct traceeval_type *vals,
+					   size_t nr_keys, size_t nr_vals,
 					   size_t sizeof_type, size_t sizeof_data)
 {
 	struct traceeval *teval;
@@ -290,25 +293,25 @@  struct traceeval *traceeval_init_data_size(struct traceeval_type *keys,
 		goto fail;
 	}
 
-	ret = check_keys(keys);
+	ret = check_keys(keys, nr_keys);
 	if (ret < 0)
 		goto fail_release;
 
 	if (vals) {
-		ret = check_vals(vals);
+		ret = check_vals(vals, nr_vals);
 		if (ret < 0)
 			goto fail_release;
 	}
 
 	/* alloc key types */
-	teval->nr_key_types = type_alloc(keys, &teval->key_types);
+	teval->nr_key_types = type_alloc(keys, &teval->key_types, nr_keys);
 	if (teval->nr_key_types <= 0) {
 		err_msg = "Failed to allocate user defined keys";
 		goto fail_release;
 	}
 
 	/* alloc val types */
-	teval->nr_val_types = type_alloc(vals, &teval->val_types);
+	teval->nr_val_types = type_alloc(vals, &teval->val_types, nr_vals);
 	if (teval->nr_val_types < 0) {
 		err_msg = "Failed to allocate user defined values";
 		goto fail_release;