[ndctl,v13,1/8] util/trace: move trace helpers from ndctl/cxl/ to ndctl/util/

Commit Message

Alison Schofield July 6, 2024, 6:24 a.m. UTC

From: Alison Schofield <[e-mail]>

A set of helpers used to parse kernel trace events were introduced
in ndctl/cxl/ in support of the CXL monitor command. The work these
helpers perform may be useful beyond CXL.

Move them to the ndctl/util/ where other generic helpers reside.
Replace cxl-ish naming with generic names and update the single
user, cxl/monitor.c, to match.

This move is in preparation for extending the helpers in support
of cxl_poison trace events.

Signed-off-by: Alison Schofield <[e-mail]>
---
 cxl/meson.build             |  2 +-
 cxl/monitor.c               | 11 +++++------
 {cxl => util}/event_trace.c | 21 ++++++++++-----------
 {cxl => util}/event_trace.h | 12 ++++++------
 4 files changed, 22 insertions(+), 24 deletions(-)
 rename {cxl => util}/event_trace.c (88%)
 rename {cxl => util}/event_trace.h (61%)

Comments

Dave Jiang July 24, 2024, 8:50 p.m. UTC | #1

On 7/5/24 11:24 PM, [e-mail] wrote:
> From: Alison Schofield <[e-mail]>
> 
> A set of helpers used to parse kernel trace events were introduced
> in ndctl/cxl/ in support of the CXL monitor command. The work these
> helpers perform may be useful beyond CXL.
> 
> Move them to the ndctl/util/ where other generic helpers reside.
> Replace cxl-ish naming with generic names and update the single
> user, cxl/monitor.c, to match.
> 
> This move is in preparation for extending the helpers in support
> of cxl_poison trace events.
> 
> Signed-off-by: Alison Schofield <[e-mail]>
Reviewed-by: Dave Jiang <[e-mail]>

> ---
>  cxl/meson.build             |  2 +-
>  cxl/monitor.c               | 11 +++++------
>  {cxl => util}/event_trace.c | 21 ++++++++++-----------
>  {cxl => util}/event_trace.h | 12 ++++++------
>  4 files changed, 22 insertions(+), 24 deletions(-)
>  rename {cxl => util}/event_trace.c (88%)
>  rename {cxl => util}/event_trace.h (61%)
> 
> diff --git a/cxl/meson.build b/cxl/meson.build
> index 61b4d8762b42..e4d1683ce8c6 100644
> --- a/cxl/meson.build
> +++ b/cxl/meson.build
> @@ -27,7 +27,7 @@ deps = [
>  
>  if get_option('libtracefs').enabled()
>    cxl_src += [
> -    'event_trace.c',
> +    '../util/event_trace.c',
>      'monitor.c',
>    ]
>    deps += [
> diff --git a/cxl/monitor.c b/cxl/monitor.c
> index a85452a4dc82..2066f984668d 100644
> --- a/cxl/monitor.c
> +++ b/cxl/monitor.c
> @@ -28,8 +28,7 @@
>  #define ENABLE_DEBUG
>  #endif
>  #include <util/log.h>
> -
> -#include "event_trace.h"
> +#include <util/event_trace.h>
>  
>  static const char *cxl_system = "cxl";
>  const char *default_log = "/var/log/cxl-monitor.log";
> @@ -87,9 +86,9 @@ static int monitor_event(struct cxl_ctx *ctx)
>  		goto epoll_ctl_err;
>  	}
>  
> -	rc = cxl_event_tracing_enable(inst, cxl_system, NULL);
> +	rc = trace_event_enable(inst, cxl_system, NULL);
>  	if (rc < 0) {
> -		err(&monitor, "cxl_trace_event_enable() failed: %d\n", rc);
> +		err(&monitor, "trace_event_enable() failed: %d\n", rc);
>  		goto event_en_err;
>  	}
>  
> @@ -112,7 +111,7 @@ static int monitor_event(struct cxl_ctx *ctx)
>  		}
>  
>  		list_head_init(&ectx.jlist_head);
> -		rc = cxl_parse_events(inst, &ectx);
> +		rc = trace_event_parse(inst, &ectx);
>  		if (rc < 0)
>  			goto parse_err;
>  
> @@ -129,7 +128,7 @@ static int monitor_event(struct cxl_ctx *ctx)
>  	}
>  
>  parse_err:
> -	if (cxl_event_tracing_disable(inst) < 0)
> +	if (trace_event_disable(inst) < 0)
>  		err(&monitor, "failed to disable tracing\n");
>  event_en_err:
>  epoll_ctl_err:
> diff --git a/cxl/event_trace.c b/util/event_trace.c
> similarity index 88%
> rename from cxl/event_trace.c
> rename to util/event_trace.c
> index 1b5aa09de8b2..16013412bc06 100644
> --- a/cxl/event_trace.c
> +++ b/util/event_trace.c
> @@ -59,8 +59,8 @@ static struct json_object *num_to_json(void *num, int elem_size, unsigned long f
>  	return json_object_new_int64(val);
>  }
>  
> -static int cxl_event_to_json(struct tep_event *event, struct tep_record *record,
> -			     struct list_head *jlist_head)
> +static int event_to_json(struct tep_event *event, struct tep_record *record,
> +			 struct list_head *jlist_head)
>  {
>  	struct json_object *jevent, *jobj, *jarray;
>  	struct tep_format_field **fields;
> @@ -200,8 +200,8 @@ err_jnode:
>  	return rc;
>  }
>  
> -static int cxl_event_parse(struct tep_event *event, struct tep_record *record,
> -			   int cpu, void *ctx)
> +static int event_parse(struct tep_event *event, struct tep_record *record,
> +		       int cpu, void *ctx)
>  {
>  	struct event_ctx *event_ctx = (struct event_ctx *)ctx;
>  
> @@ -218,10 +218,10 @@ static int cxl_event_parse(struct tep_event *event, struct tep_record *record,
>  		return event_ctx->parse_event(event, record,
>  					      &event_ctx->jlist_head);
>  
> -	return cxl_event_to_json(event, record, &event_ctx->jlist_head);
> +	return event_to_json(event, record, &event_ctx->jlist_head);
>  }
>  
> -int cxl_parse_events(struct tracefs_instance *inst, struct event_ctx *ectx)
> +int trace_event_parse(struct tracefs_instance *inst, struct event_ctx *ectx)
>  {
>  	struct tep_handle *tep;
>  	int rc;
> @@ -230,14 +230,13 @@ int cxl_parse_events(struct tracefs_instance *inst, struct event_ctx *ectx)
>  	if (!tep)
>  		return -ENOMEM;
>  
> -	rc = tracefs_iterate_raw_events(tep, inst, NULL, 0, cxl_event_parse,
> -					ectx);
> +	rc = tracefs_iterate_raw_events(tep, inst, NULL, 0, event_parse, ectx);
>  	tep_free(tep);
>  	return rc;
>  }
>  
> -int cxl_event_tracing_enable(struct tracefs_instance *inst, const char *system,
> -		const char *event)
> +int trace_event_enable(struct tracefs_instance *inst, const char *system,
> +		       const char *event)
>  {
>  	int rc;
>  
> @@ -252,7 +251,7 @@ int cxl_event_tracing_enable(struct tracefs_instance *inst, const char *system,
>  	return 0;
>  }
>  
> -int cxl_event_tracing_disable(struct tracefs_instance *inst)
> +int trace_event_disable(struct tracefs_instance *inst)
>  {
>  	return tracefs_trace_off(inst);
>  }
> diff --git a/cxl/event_trace.h b/util/event_trace.h
> similarity index 61%
> rename from cxl/event_trace.h
> rename to util/event_trace.h
> index ec6267202c8b..37c39aded871 100644
> --- a/cxl/event_trace.h
> +++ b/util/event_trace.h
> @@ -1,7 +1,7 @@
>  /* SPDX-License-Identifier: GPL-2.0 */
>  /* Copyright (C) 2022 Intel Corporation. All rights reserved. */
> -#ifndef __CXL_EVENT_TRACE_H__
> -#define __CXL_EVENT_TRACE_H__
> +#ifndef __UTIL_EVENT_TRACE_H__
> +#define __UTIL_EVENT_TRACE_H__
>  
>  #include <json-c/json.h>
>  #include <ccan/list/list.h>
> @@ -19,9 +19,9 @@ struct event_ctx {
>  			   struct list_head *jlist_head); /* optional */
>  };
>  
> -int cxl_parse_events(struct tracefs_instance *inst, struct event_ctx *ectx);
> -int cxl_event_tracing_enable(struct tracefs_instance *inst, const char *system,
> -		const char *event);
> -int cxl_event_tracing_disable(struct tracefs_instance *inst);
> +int trace_event_parse(struct tracefs_instance *inst, struct event_ctx *ectx);
> +int trace_event_enable(struct tracefs_instance *inst, const char *system,
> +		       const char *event);
> +int trace_event_disable(struct tracefs_instance *inst);
>  
>  #endif

Patch

diff --git a/cxl/meson.build b/cxl/meson.build
index 61b4d8762b42..e4d1683ce8c6 100644
--- a/cxl/meson.build
+++ b/cxl/meson.build
@@ -27,7 +27,7 @@  deps = [
 
 if get_option('libtracefs').enabled()
   cxl_src += [
-    'event_trace.c',
+    '../util/event_trace.c',
     'monitor.c',
   ]
   deps += [
diff --git a/cxl/monitor.c b/cxl/monitor.c
index a85452a4dc82..2066f984668d 100644
--- a/cxl/monitor.c
+++ b/cxl/monitor.c
@@ -28,8 +28,7 @@ 
 #define ENABLE_DEBUG
 #endif
 #include <util/log.h>
-
-#include "event_trace.h"
+#include <util/event_trace.h>
 
 static const char *cxl_system = "cxl";
 const char *default_log = "/var/log/cxl-monitor.log";
@@ -87,9 +86,9 @@  static int monitor_event(struct cxl_ctx *ctx)
 		goto epoll_ctl_err;
 	}
 
-	rc = cxl_event_tracing_enable(inst, cxl_system, NULL);
+	rc = trace_event_enable(inst, cxl_system, NULL);
 	if (rc < 0) {
-		err(&monitor, "cxl_trace_event_enable() failed: %d\n", rc);
+		err(&monitor, "trace_event_enable() failed: %d\n", rc);
 		goto event_en_err;
 	}
 
@@ -112,7 +111,7 @@  static int monitor_event(struct cxl_ctx *ctx)
 		}
 
 		list_head_init(&ectx.jlist_head);
-		rc = cxl_parse_events(inst, &ectx);
+		rc = trace_event_parse(inst, &ectx);
 		if (rc < 0)
 			goto parse_err;
 
@@ -129,7 +128,7 @@  static int monitor_event(struct cxl_ctx *ctx)
 	}
 
 parse_err:
-	if (cxl_event_tracing_disable(inst) < 0)
+	if (trace_event_disable(inst) < 0)
 		err(&monitor, "failed to disable tracing\n");
 event_en_err:
 epoll_ctl_err:
diff --git a/cxl/event_trace.c b/util/event_trace.c
similarity index 88%
rename from cxl/event_trace.c
rename to util/event_trace.c
index 1b5aa09de8b2..16013412bc06 100644
--- a/cxl/event_trace.c
+++ b/util/event_trace.c
@@ -59,8 +59,8 @@  static struct json_object *num_to_json(void *num, int elem_size, unsigned long f
 	return json_object_new_int64(val);
 }
 
-static int cxl_event_to_json(struct tep_event *event, struct tep_record *record,
-			     struct list_head *jlist_head)
+static int event_to_json(struct tep_event *event, struct tep_record *record,
+			 struct list_head *jlist_head)
 {
 	struct json_object *jevent, *jobj, *jarray;
 	struct tep_format_field **fields;
@@ -200,8 +200,8 @@  err_jnode:
 	return rc;
 }
 
-static int cxl_event_parse(struct tep_event *event, struct tep_record *record,
-			   int cpu, void *ctx)
+static int event_parse(struct tep_event *event, struct tep_record *record,
+		       int cpu, void *ctx)
 {
 	struct event_ctx *event_ctx = (struct event_ctx *)ctx;
 
@@ -218,10 +218,10 @@  static int cxl_event_parse(struct tep_event *event, struct tep_record *record,
 		return event_ctx->parse_event(event, record,
 					      &event_ctx->jlist_head);
 
-	return cxl_event_to_json(event, record, &event_ctx->jlist_head);
+	return event_to_json(event, record, &event_ctx->jlist_head);
 }
 
-int cxl_parse_events(struct tracefs_instance *inst, struct event_ctx *ectx)
+int trace_event_parse(struct tracefs_instance *inst, struct event_ctx *ectx)
 {
 	struct tep_handle *tep;
 	int rc;
@@ -230,14 +230,13 @@  int cxl_parse_events(struct tracefs_instance *inst, struct event_ctx *ectx)
 	if (!tep)
 		return -ENOMEM;
 
-	rc = tracefs_iterate_raw_events(tep, inst, NULL, 0, cxl_event_parse,
-					ectx);
+	rc = tracefs_iterate_raw_events(tep, inst, NULL, 0, event_parse, ectx);
 	tep_free(tep);
 	return rc;
 }
 
-int cxl_event_tracing_enable(struct tracefs_instance *inst, const char *system,
-		const char *event)
+int trace_event_enable(struct tracefs_instance *inst, const char *system,
+		       const char *event)
 {
 	int rc;
 
@@ -252,7 +251,7 @@  int cxl_event_tracing_enable(struct tracefs_instance *inst, const char *system,
 	return 0;
 }
 
-int cxl_event_tracing_disable(struct tracefs_instance *inst)
+int trace_event_disable(struct tracefs_instance *inst)
 {
 	return tracefs_trace_off(inst);
 }
diff --git a/cxl/event_trace.h b/util/event_trace.h
similarity index 61%
rename from cxl/event_trace.h
rename to util/event_trace.h
index ec6267202c8b..37c39aded871 100644
--- a/cxl/event_trace.h
+++ b/util/event_trace.h
@@ -1,7 +1,7 @@ 
 /* SPDX-License-Identifier: GPL-2.0 */
 /* Copyright (C) 2022 Intel Corporation. All rights reserved. */
-#ifndef __CXL_EVENT_TRACE_H__
-#define __CXL_EVENT_TRACE_H__
+#ifndef __UTIL_EVENT_TRACE_H__
+#define __UTIL_EVENT_TRACE_H__
 
 #include <json-c/json.h>
 #include <ccan/list/list.h>
@@ -19,9 +19,9 @@  struct event_ctx {
 			   struct list_head *jlist_head); /* optional */
 };
 
-int cxl_parse_events(struct tracefs_instance *inst, struct event_ctx *ectx);
-int cxl_event_tracing_enable(struct tracefs_instance *inst, const char *system,
-		const char *event);
-int cxl_event_tracing_disable(struct tracefs_instance *inst);
+int trace_event_parse(struct tracefs_instance *inst, struct event_ctx *ectx);
+int trace_event_enable(struct tracefs_instance *inst, const char *system,
+		       const char *event);
+int trace_event_disable(struct tracefs_instance *inst);
 
 #endif