Linux CXL
 help / color / mirror / Atom feed
* [ndctl PATCH v2] cxl/list: remove libtracefs build dependency for --media-errors
@ 2025-09-24  4:52 Alison Schofield
  2025-09-24 15:40 ` Dave Jiang
                   ` (3 more replies)
  0 siblings, 4 replies; 6+ messages in thread
From: Alison Schofield @ 2025-09-24  4:52 UTC (permalink / raw)
  To: nvdimm, linux-cxl; +Cc: Alison Schofield, Andreas Hasenack

When the --media-errors option was added to cxl list it inadvertently
changed the optional libtracefs requirement into a mandatory one.
Ndctl versions 80,81,82 no longer build without libtracefs.

Remove that dependency.

When libtracefs is disabled the user will see a 'Notice' level
message, like this:
	$ cxl list -r region0 --media-errors --targets
	cxl list: cmd_list: --media-errors support disabled at build time

...followed by the region listing including the output for any other
valid command line options, like --targets in the example above.

When libtracefs is disabled the cxl-poison.sh unit test is omitted.

The man page gets a note:
	The media-error option is only available with -Dlibtracefs=enabled.

Reported-by: Andreas Hasenack <andreas.hasenack@canonical.com>
Fixes: d7532bb049e0 ("cxl/list: add --media-errors option to cxl list")
Closes: https://github.com/pmem/ndctl/issues/289
Signed-off-by: Alison Schofield <alison.schofield@intel.com>
---

Changes in v2:
- Notify and continue when --media-error info is unavailable (Dan)


 Documentation/cxl/cxl-list.txt |  2 ++
 config.h.meson                 |  2 +-
 cxl/json.c                     | 15 ++++++++++++++-
 cxl/list.c                     |  6 ++++++
 test/meson.build               |  9 +++++++--
 5 files changed, 30 insertions(+), 4 deletions(-)

diff --git a/Documentation/cxl/cxl-list.txt b/Documentation/cxl/cxl-list.txt
index 9a9911e7dd9b..0595638ee054 100644
--- a/Documentation/cxl/cxl-list.txt
+++ b/Documentation/cxl/cxl-list.txt
@@ -425,6 +425,8 @@ OPTIONS
 	"source:" is one of: External, Internal, Injected, Vendor Specific,
 	or Unknown, as defined in CXL Specification v3.1 Table 8-140.
 
+The media-errors option is only available with '-Dlibtracefs=enabled'.
+
 ----
 # cxl list -m mem9 --media-errors -u
 {
diff --git a/config.h.meson b/config.h.meson
index f75db3e6360f..e8539f8d04df 100644
--- a/config.h.meson
+++ b/config.h.meson
@@ -19,7 +19,7 @@
 /* ndctl test support */
 #mesondefine ENABLE_TEST
 
-/* cxl monitor support */
+/* cxl monitor and cxl list --media-errors support */
 #mesondefine ENABLE_LIBTRACEFS
 
 /* Define to 1 if big-endian-arch */
diff --git a/cxl/json.c b/cxl/json.c
index e65bd803b706..a75928bf43ed 100644
--- a/cxl/json.c
+++ b/cxl/json.c
@@ -9,12 +9,15 @@
 #include <json-c/json.h>
 #include <json-c/printbuf.h>
 #include <ccan/short_types/short_types.h>
+
+#ifdef ENABLE_LIBTRACEFS
 #include <tracefs.h>
+#include "../util/event_trace.h"
+#endif
 
 #include "filter.h"
 #include "json.h"
 #include "../daxctl/json.h"
-#include "../util/event_trace.h"
 
 #define CXL_FW_VERSION_STR_LEN	16
 #define CXL_FW_MAX_SLOTS	4
@@ -575,6 +578,7 @@ err_jobj:
 	return NULL;
 }
 
+#ifdef ENABLE_LIBTRACEFS
 /* CXL Spec 3.1 Table 8-140 Media Error Record */
 #define CXL_POISON_SOURCE_MAX 7
 static const char *const poison_source[] = { "Unknown", "External", "Internal",
@@ -753,6 +757,15 @@ err_free:
 	tracefs_instance_free(inst);
 	return jpoison;
 }
+#else
+static struct json_object *
+util_cxl_poison_list_to_json(struct cxl_region *region,
+			     struct cxl_memdev *memdev,
+			     unsigned long flags)
+{
+	return NULL;
+}
+#endif
 
 struct json_object *util_cxl_memdev_to_json(struct cxl_memdev *memdev,
 		unsigned long flags)
diff --git a/cxl/list.c b/cxl/list.c
index 0b25d78248d5..48bd1ebc3c0e 100644
--- a/cxl/list.c
+++ b/cxl/list.c
@@ -146,6 +146,12 @@ int cmd_list(int argc, const char **argv, struct cxl_ctx *ctx)
 		param.ctx.log_priority = LOG_DEBUG;
 	}
 
+#ifndef ENABLE_LIBTRACEFS
+	if (param.media_errors) {
+		notice(&param, "--media-errors support disabled at build time\n");
+		param.media_errors = false;
+	}
+#endif
 	if (cxl_filter_has(param.port_filter, "root") && param.ports)
 		param.buses = true;
 
diff --git a/test/meson.build b/test/meson.build
index 775542c1b787..615376ea635a 100644
--- a/test/meson.build
+++ b/test/meson.build
@@ -167,7 +167,6 @@ cxl_events = find_program('cxl-events.sh')
 cxl_sanitize = find_program('cxl-sanitize.sh')
 cxl_destroy_region = find_program('cxl-destroy-region.sh')
 cxl_qos_class = find_program('cxl-qos-class.sh')
-cxl_poison = find_program('cxl-poison.sh')
 
 tests = [
   [ 'libndctl',               libndctl,		  'ndctl' ],
@@ -200,7 +199,6 @@ tests = [
   [ 'cxl-sanitize.sh',        cxl_sanitize,       'cxl'   ],
   [ 'cxl-destroy-region.sh',  cxl_destroy_region, 'cxl'   ],
   [ 'cxl-qos-class.sh',       cxl_qos_class,      'cxl'   ],
-  [ 'cxl-poison.sh',          cxl_poison,         'cxl'   ],
 ]
 
 if get_option('destructive').enabled()
@@ -253,6 +251,13 @@ if get_option('fwctl').enabled()
   ]
 endif
 
+if get_option('libtracefs').enabled()
+  cxl_poison = find_program('cxl-poison.sh')
+  tests += [
+    [ 'cxl-poison.sh', cxl_poison, 'cxl' ],
+  ]
+endif
+
 test_env = [
     'LC_ALL=C',
     'NDCTL=@0@'.format(ndctl_tool.full_path()),
-- 
2.37.3


^ permalink raw reply related	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2025-09-25  0:27 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-24  4:52 [ndctl PATCH v2] cxl/list: remove libtracefs build dependency for --media-errors Alison Schofield
2025-09-24 15:40 ` Dave Jiang
2025-09-24 19:53 ` Verma, Vishal L
2025-09-24 20:53 ` Alison Schofield
2025-09-24 23:10 ` dan.j.williams
2025-09-25  0:27   ` Alison Schofield

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox