netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support
@ 2025-02-28 12:50 Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 1/8] netconsole: prefix CPU_NR sysdata feature with SYSDATA_ Breno Leitao
                   ` (8 more replies)
  0 siblings, 9 replies; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

This patchset introduces a new feature to the netconsole extradata
subsystem that enables the inclusion of the current task's name in the
sysdata output of netconsole messages.

This enhancement is particularly valuable for large-scale deployments,
such as Meta's, where netconsole collects messages from millions of
servers and stores them in a data warehouse for analysis. Engineers
often rely on these messages to investigate issues and assess kernel
health.

One common challenge we face is determining the context in which
a particular message was generated. By including the task name
(task->comm) with each message, this feature provides a direct answer to
the frequently asked question: "What was running when this message was
generated?"

This added context will significantly improve our ability to diagnose
and troubleshoot issues, making it easier to interpret output of
netconsole.

The patchset consists of seven patches that implement the following changes:

 * Refactor CPU number formatting into a separate function
 * Prefix CPU_NR sysdata feature with SYSDATA_
 * Patch to covert a bitwise operation into boolean
 * Add configfs controls for taskname sysdata feature
 * Add taskname to extradata entry count
 * Add support for including task name in netconsole's extra data output
 * Document the task name feature in Documentation/networking/netconsole.rst
 * Add test coverage for the task name feature to the existing sysdata selftest script

These changes allow users to enable or disable the task name feature via
configfs and provide additional context for kernel messages by showing
which task generated each console message.

I have tested these patches on some servers and they seem to work as
expected.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
Changes in v2:
- Add an extra patch to convert the comparison more stable. (Paolo)
- Changed the argument of a function (Simon)
- Removed the warn on `current == NULLL` since it shouldn't be the case.
  (Simon and Paolo)
- Link to v1: https://lore.kernel.org/r/20250221-netcons_current-v1-0-21c86ae8fc0d@debian.org

---
Breno Leitao (8):
      netconsole: prefix CPU_NR sysdata feature with SYSDATA_
      netconsole: Make boolean comparison consistent
      netconsole: refactor CPU number formatting into separate function
      netconsole: add taskname to extradata entry count
      netconsole: add configfs controls for taskname sysdata feature
      netconsole: add task name to extra data fields
      netconsole: docs: document the task name feature
      netconsole: selftest: add task name append testing

 Documentation/networking/netconsole.rst            | 28 +++++++
 drivers/net/netconsole.c                           | 95 ++++++++++++++++++----
 .../selftests/drivers/net/netcons_sysdata.sh       | 51 ++++++++++--
 3 files changed, 153 insertions(+), 21 deletions(-)
---
base-commit: 56794b5862c5a9aefcf2b703257c6fb93f76573e
change-id: 20250217-netcons_current-2c635fa5beda
prerequisite-change-id: 20250212-netdevsim-258d2d628175:v3
prerequisite-patch-id: 4ecfdbc58dd599d2358655e4ad742cbb9dde39f3

Best regards,
-- 
Breno Leitao <leitao@debian.org>


^ permalink raw reply	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 1/8] netconsole: prefix CPU_NR sysdata feature with SYSDATA_
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 2/8] netconsole: Make boolean comparison consistent Breno Leitao
                   ` (7 subsequent siblings)
  8 siblings, 0 replies; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

Rename the CPU_NR enum value to SYSDATA_CPU_NR to establish a consistent
naming convention for sysdata features. This change prepares for
upcoming additions to the sysdata feature set by clearly grouping
related features under the SYSDATA prefix.

This change is purely cosmetic and does not modify any functionality.

Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
---
 drivers/net/netconsole.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/net/netconsole.c b/drivers/net/netconsole.c
index f77eddf221850..c086e2fe51f87 100644
--- a/drivers/net/netconsole.c
+++ b/drivers/net/netconsole.c
@@ -103,7 +103,7 @@ struct netconsole_target_stats  {
  */
 enum sysdata_feature {
 	/* Populate the CPU that sends the message */
-	CPU_NR = BIT(0),
+	SYSDATA_CPU_NR = BIT(0),
 };
 
 /**
@@ -418,7 +418,7 @@ static ssize_t sysdata_cpu_nr_enabled_show(struct config_item *item, char *buf)
 	bool cpu_nr_enabled;
 
 	mutex_lock(&dynamic_netconsole_mutex);
-	cpu_nr_enabled = !!(nt->sysdata_fields & CPU_NR);
+	cpu_nr_enabled = !!(nt->sysdata_fields & SYSDATA_CPU_NR);
 	mutex_unlock(&dynamic_netconsole_mutex);
 
 	return sysfs_emit(buf, "%d\n", cpu_nr_enabled);
@@ -699,7 +699,7 @@ static size_t count_extradata_entries(struct netconsole_target *nt)
 	/* Userdata entries */
 	entries = list_count_nodes(&nt->userdata_group.cg_children);
 	/* Plus sysdata entries */
-	if (nt->sysdata_fields & CPU_NR)
+	if (nt->sysdata_fields & SYSDATA_CPU_NR)
 		entries += 1;
 
 	return entries;
@@ -850,7 +850,7 @@ static ssize_t sysdata_cpu_nr_enabled_store(struct config_item *item,
 		return ret;
 
 	mutex_lock(&dynamic_netconsole_mutex);
-	curr = nt->sysdata_fields & CPU_NR;
+	curr = nt->sysdata_fields & SYSDATA_CPU_NR;
 	if (cpu_nr_enabled == curr)
 		/* no change requested */
 		goto unlock_ok;
@@ -865,13 +865,13 @@ static ssize_t sysdata_cpu_nr_enabled_store(struct config_item *item,
 	}
 
 	if (cpu_nr_enabled)
-		nt->sysdata_fields |= CPU_NR;
+		nt->sysdata_fields |= SYSDATA_CPU_NR;
 	else
 		/* This is special because extradata_complete might have
 		 * remaining data from previous sysdata, and it needs to be
 		 * cleaned.
 		 */
-		disable_sysdata_feature(nt, CPU_NR);
+		disable_sysdata_feature(nt, SYSDATA_CPU_NR);
 
 unlock_ok:
 	ret = strnlen(buf, count);
@@ -1130,7 +1130,7 @@ static int prepare_extradata(struct netconsole_target *nt)
 	 */
 	extradata_len = nt->userdata_length;
 
-	if (!(nt->sysdata_fields & CPU_NR))
+	if (!(nt->sysdata_fields & SYSDATA_CPU_NR))
 		goto out;
 
 	/* Append cpu=%d at extradata_complete after userdata str */

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 2/8] netconsole: Make boolean comparison consistent
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 1/8] netconsole: prefix CPU_NR sysdata feature with SYSDATA_ Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-03-04 11:50   ` Simon Horman
  2025-02-28 12:50 ` [PATCH net-next v2 3/8] netconsole: refactor CPU number formatting into separate function Breno Leitao
                   ` (6 subsequent siblings)
  8 siblings, 1 reply; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

Convert the current state assignment to use explicit boolean conversion,
making the code more robust and easier to read. This change adds a
double-negation operator to ensure consistent boolean conversion as
suggested by Paolo[1].

This approach aligns with the existing pattern used in
sysdata_cpu_nr_enabled_show().

Link: https://lore.kernel.org/all/7309e760-63b0-4b58-ad33-2fb8db361141@redhat.com/ [1]
Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/netconsole.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/net/netconsole.c b/drivers/net/netconsole.c
index c086e2fe51f87..698dbbea2713f 100644
--- a/drivers/net/netconsole.c
+++ b/drivers/net/netconsole.c
@@ -850,7 +850,7 @@ static ssize_t sysdata_cpu_nr_enabled_store(struct config_item *item,
 		return ret;
 
 	mutex_lock(&dynamic_netconsole_mutex);
-	curr = nt->sysdata_fields & SYSDATA_CPU_NR;
+	curr = !!(nt->sysdata_fields & SYSDATA_CPU_NR);
 	if (cpu_nr_enabled == curr)
 		/* no change requested */
 		goto unlock_ok;

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 3/8] netconsole: refactor CPU number formatting into separate function
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 1/8] netconsole: prefix CPU_NR sysdata feature with SYSDATA_ Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 2/8] netconsole: Make boolean comparison consistent Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 4/8] netconsole: add taskname to extradata entry count Breno Leitao
                   ` (5 subsequent siblings)
  8 siblings, 0 replies; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

Extract CPU number formatting logic from prepare_extradata() into a new
append_cpu_nr() function.

This refactoring improves code organization by isolating CPU number
formatting into its own function while reducing the complexity of
prepare_extradata().

The change prepares the codebase for the upcoming taskname feature by
establishing a consistent pattern for handling sysdata features.

The CPU number formatting logic itself remains unchanged; only its
location has moved to improve maintainability.

Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
---
 drivers/net/netconsole.c | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/drivers/net/netconsole.c b/drivers/net/netconsole.c
index 698dbbea2713f..96153fd01f46e 100644
--- a/drivers/net/netconsole.c
+++ b/drivers/net/netconsole.c
@@ -1117,13 +1117,21 @@ static void populate_configfs_item(struct netconsole_target *nt,
 	init_target_config_group(nt, target_name);
 }
 
+static int append_cpu_nr(struct netconsole_target *nt, int offset)
+{
+	/* Append cpu=%d at extradata_complete after userdata str */
+	return scnprintf(&nt->extradata_complete[offset],
+			 MAX_EXTRADATA_ENTRY_LEN, " cpu=%u\n",
+			 raw_smp_processor_id());
+}
+
 /*
  * prepare_extradata - append sysdata at extradata_complete in runtime
  * @nt: target to send message to
  */
 static int prepare_extradata(struct netconsole_target *nt)
 {
-	int sysdata_len, extradata_len;
+	int extradata_len;
 
 	/* userdata was appended when configfs write helper was called
 	 * by update_userdata().
@@ -1133,12 +1141,8 @@ static int prepare_extradata(struct netconsole_target *nt)
 	if (!(nt->sysdata_fields & SYSDATA_CPU_NR))
 		goto out;
 
-	/* Append cpu=%d at extradata_complete after userdata str */
-	sysdata_len = scnprintf(&nt->extradata_complete[nt->userdata_length],
-				MAX_EXTRADATA_ENTRY_LEN, " cpu=%u\n",
-				raw_smp_processor_id());
-
-	extradata_len += sysdata_len;
+	if (nt->sysdata_fields & SYSDATA_CPU_NR)
+		extradata_len += append_cpu_nr(nt, extradata_len);
 
 	WARN_ON_ONCE(extradata_len >
 		     MAX_EXTRADATA_ENTRY_LEN * MAX_EXTRADATA_ITEMS);

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 4/8] netconsole: add taskname to extradata entry count
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
                   ` (2 preceding siblings ...)
  2025-02-28 12:50 ` [PATCH net-next v2 3/8] netconsole: refactor CPU number formatting into separate function Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 5/8] netconsole: add configfs controls for taskname sysdata feature Breno Leitao
                   ` (4 subsequent siblings)
  8 siblings, 0 replies; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

New SYSDATA_TASKNAME feature flag to track when taskname append is enabled.

Additional check in count_extradata_entries() to include taskname in
total, counting it as an entry in extradata. This function is used to
check if we are not overflowing the number of extradata items.

Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
---
 drivers/net/netconsole.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/net/netconsole.c b/drivers/net/netconsole.c
index 96153fd01f46e..f46a0edf9c11e 100644
--- a/drivers/net/netconsole.c
+++ b/drivers/net/netconsole.c
@@ -104,6 +104,8 @@ struct netconsole_target_stats  {
 enum sysdata_feature {
 	/* Populate the CPU that sends the message */
 	SYSDATA_CPU_NR = BIT(0),
+	/* Populate the task name (as in current->comm) in sysdata */
+	SYSDATA_TASKNAME = BIT(1),
 };
 
 /**
@@ -701,6 +703,8 @@ static size_t count_extradata_entries(struct netconsole_target *nt)
 	/* Plus sysdata entries */
 	if (nt->sysdata_fields & SYSDATA_CPU_NR)
 		entries += 1;
+	if (nt->sysdata_fields & SYSDATA_TASKNAME)
+		entries += 1;
 
 	return entries;
 }

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 5/8] netconsole: add configfs controls for taskname sysdata feature
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
                   ` (3 preceding siblings ...)
  2025-02-28 12:50 ` [PATCH net-next v2 4/8] netconsole: add taskname to extradata entry count Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 6/8] netconsole: add task name to extra data fields Breno Leitao
                   ` (3 subsequent siblings)
  8 siblings, 0 replies; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

Add configfs interface to enable/disable the taskname sysdata feature.
This adds the following functionality:

The implementation follows the same pattern as the existing CPU number
feature, ensuring consistent behavior and error handling across sysdata
features.

Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
---
 drivers/net/netconsole.c | 50 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/drivers/net/netconsole.c b/drivers/net/netconsole.c
index f46a0edf9c11e..9798b2b409e26 100644
--- a/drivers/net/netconsole.c
+++ b/drivers/net/netconsole.c
@@ -426,6 +426,20 @@ static ssize_t sysdata_cpu_nr_enabled_show(struct config_item *item, char *buf)
 	return sysfs_emit(buf, "%d\n", cpu_nr_enabled);
 }
 
+/* configfs helper to display if taskname sysdata feature is enabled */
+static ssize_t sysdata_taskname_enabled_show(struct config_item *item,
+					     char *buf)
+{
+	struct netconsole_target *nt = to_target(item->ci_parent);
+	bool taskname_enabled;
+
+	mutex_lock(&dynamic_netconsole_mutex);
+	taskname_enabled = !!(nt->sysdata_fields & SYSDATA_TASKNAME);
+	mutex_unlock(&dynamic_netconsole_mutex);
+
+	return sysfs_emit(buf, "%d\n", taskname_enabled);
+}
+
 /*
  * This one is special -- targets created through the configfs interface
  * are not enabled (and the corresponding netpoll activated) by default.
@@ -841,6 +855,40 @@ static void disable_sysdata_feature(struct netconsole_target *nt,
 	nt->extradata_complete[nt->userdata_length] = 0;
 }
 
+static ssize_t sysdata_taskname_enabled_store(struct config_item *item,
+					      const char *buf, size_t count)
+{
+	struct netconsole_target *nt = to_target(item->ci_parent);
+	bool taskname_enabled, curr;
+	ssize_t ret;
+
+	ret = kstrtobool(buf, &taskname_enabled);
+	if (ret)
+		return ret;
+
+	mutex_lock(&dynamic_netconsole_mutex);
+	curr = !!(nt->sysdata_fields & SYSDATA_TASKNAME);
+	if (taskname_enabled == curr)
+		goto unlock_ok;
+
+	if (taskname_enabled &&
+	    count_extradata_entries(nt) >= MAX_EXTRADATA_ITEMS) {
+		ret = -ENOSPC;
+		goto unlock;
+	}
+
+	if (taskname_enabled)
+		nt->sysdata_fields |= SYSDATA_TASKNAME;
+	else
+		disable_sysdata_feature(nt, SYSDATA_TASKNAME);
+
+unlock_ok:
+	ret = strnlen(buf, count);
+unlock:
+	mutex_unlock(&dynamic_netconsole_mutex);
+	return ret;
+}
+
 /* configfs helper to sysdata cpu_nr feature */
 static ssize_t sysdata_cpu_nr_enabled_store(struct config_item *item,
 					    const char *buf, size_t count)
@@ -886,6 +934,7 @@ static ssize_t sysdata_cpu_nr_enabled_store(struct config_item *item,
 
 CONFIGFS_ATTR(userdatum_, value);
 CONFIGFS_ATTR(sysdata_, cpu_nr_enabled);
+CONFIGFS_ATTR(sysdata_, taskname_enabled);
 
 static struct configfs_attribute *userdatum_attrs[] = {
 	&userdatum_attr_value,
@@ -946,6 +995,7 @@ static void userdatum_drop(struct config_group *group, struct config_item *item)
 
 static struct configfs_attribute *userdata_attrs[] = {
 	&sysdata_attr_cpu_nr_enabled,
+	&sysdata_attr_taskname_enabled,
 	NULL,
 };
 

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 6/8] netconsole: add task name to extra data fields
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
                   ` (4 preceding siblings ...)
  2025-02-28 12:50 ` [PATCH net-next v2 5/8] netconsole: add configfs controls for taskname sysdata feature Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-03-04 11:52   ` Simon Horman
  2025-02-28 12:50 ` [PATCH net-next v2 7/8] netconsole: docs: document the task name feature Breno Leitao
                   ` (2 subsequent siblings)
  8 siblings, 1 reply; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

This is the core patch for this whole patchset. Add support for
including the current task's name in netconsole's extra data output.
This adds a new append_taskname() function that writes the task name
(from current->comm) into the target's extradata buffer, similar to how
CPU numbers are handled.

The task name is included when the SYSDATA_TASKNAME field is set,
appearing in the format "taskname=<name>" in the output. This additional
context can help with debugging by showing which task generated each
console message.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/netconsole.c | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/drivers/net/netconsole.c b/drivers/net/netconsole.c
index 9798b2b409e26..098ea9eb02373 100644
--- a/drivers/net/netconsole.c
+++ b/drivers/net/netconsole.c
@@ -1179,12 +1179,19 @@ static int append_cpu_nr(struct netconsole_target *nt, int offset)
 			 raw_smp_processor_id());
 }
 
+static int append_taskname(struct netconsole_target *nt, int offset)
+{
+	return scnprintf(&nt->extradata_complete[offset],
+			 MAX_EXTRADATA_ENTRY_LEN, " taskname=%s\n",
+			 current->comm);
+}
 /*
  * prepare_extradata - append sysdata at extradata_complete in runtime
  * @nt: target to send message to
  */
 static int prepare_extradata(struct netconsole_target *nt)
 {
+	u32 fields = SYSDATA_CPU_NR | SYSDATA_TASKNAME;
 	int extradata_len;
 
 	/* userdata was appended when configfs write helper was called
@@ -1192,11 +1199,13 @@ static int prepare_extradata(struct netconsole_target *nt)
 	 */
 	extradata_len = nt->userdata_length;
 
-	if (!(nt->sysdata_fields & SYSDATA_CPU_NR))
+	if (!(nt->sysdata_fields & fields))
 		goto out;
 
 	if (nt->sysdata_fields & SYSDATA_CPU_NR)
 		extradata_len += append_cpu_nr(nt, extradata_len);
+	if (nt->sysdata_fields & SYSDATA_TASKNAME)
+		extradata_len += append_taskname(nt, extradata_len);
 
 	WARN_ON_ONCE(extradata_len >
 		     MAX_EXTRADATA_ENTRY_LEN * MAX_EXTRADATA_ITEMS);

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 7/8] netconsole: docs: document the task name feature
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
                   ` (5 preceding siblings ...)
  2025-02-28 12:50 ` [PATCH net-next v2 6/8] netconsole: add task name to extra data fields Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-02-28 12:50 ` [PATCH net-next v2 8/8] netconsole: selftest: add task name append testing Breno Leitao
  2025-03-04 14:50 ` [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support patchwork-bot+netdevbpf
  8 siblings, 0 replies; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

Add documentation for the netconsole task name feature in
Documentation/networking/netconsole.rst. This explains how to enable
task name via configfs and demonstrates the output format.

The documentation includes:
- How to enable/disable the feature via taskname_enabled
- The format of the task name in the output
- An example showing the task name appearing in messages

Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
---
 Documentation/networking/netconsole.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/Documentation/networking/netconsole.rst b/Documentation/networking/netconsole.rst
index 84803c59968a3..ae82a6337a8d8 100644
--- a/Documentation/networking/netconsole.rst
+++ b/Documentation/networking/netconsole.rst
@@ -240,6 +240,34 @@ Delete `userdata` entries with `rmdir`::
 
    It is recommended to not write user data values with newlines.
 
+Task name auto population in userdata
+-------------------------------------
+
+Inside the netconsole configfs hierarchy, there is a file called
+`taskname_enabled` under the `userdata` directory. This file is used to enable
+or disable the automatic task name population feature. This feature
+automatically populates the current task name that is scheduled in the CPU
+sneding the message.
+
+To enable task name auto-population::
+
+  echo 1 > /sys/kernel/config/netconsole/target1/userdata/taskname_enabled
+
+When this option is enabled, the netconsole messages will include an additional
+line in the userdata field with the format `taskname=<task name>`. This allows
+the receiver of the netconsole messages to easily find which application was
+currently scheduled when that message was generated, providing extra context
+for kernel messages and helping to categorize them.
+
+Example::
+
+  echo "This is a message" > /dev/kmsg
+  12,607,22085407756,-;This is a message
+   taskname=echo
+
+In this example, the message was generated while "echo" was the current
+scheduled process.
+
 CPU number auto population in userdata
 --------------------------------------
 

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH net-next v2 8/8] netconsole: selftest: add task name append testing
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
                   ` (6 preceding siblings ...)
  2025-02-28 12:50 ` [PATCH net-next v2 7/8] netconsole: docs: document the task name feature Breno Leitao
@ 2025-02-28 12:50 ` Breno Leitao
  2025-03-04 14:50 ` [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support patchwork-bot+netdevbpf
  8 siblings, 0 replies; 12+ messages in thread
From: Breno Leitao @ 2025-02-28 12:50 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Jonathan Corbet, Shuah Khan
  Cc: netdev, linux-kernel, linux-doc, linux-kselftest, Breno Leitao,
	kernel-team

Add test coverage for the netconsole task name feature to the existing
sysdata selftest script. This extends the test infrastructure to verify
that task names are correctly appended when enabled and absent when
disabled.

The test validates that:
  - Task names appear in the expected format "taskname=<name>"
  - Task names are included when the feature is enabled
  - Task names are excluded when the feature is disabled
  - The feature works correctly alongside other sysdata fields like CPU

Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
---
 .../selftests/drivers/net/netcons_sysdata.sh       | 51 +++++++++++++++++++---
 1 file changed, 44 insertions(+), 7 deletions(-)

diff --git a/tools/testing/selftests/drivers/net/netcons_sysdata.sh b/tools/testing/selftests/drivers/net/netcons_sysdata.sh
index 2b78fd1f5982f..f351206ed1bda 100755
--- a/tools/testing/selftests/drivers/net/netcons_sysdata.sh
+++ b/tools/testing/selftests/drivers/net/netcons_sysdata.sh
@@ -31,17 +31,38 @@ function set_cpu_nr() {
 	echo 1 > "${NETCONS_PATH}/userdata/cpu_nr_enabled"
 }
 
+# Enable the taskname to be appended to sysdata
+function set_taskname() {
+	if [[ ! -f "${NETCONS_PATH}/userdata/taskname_enabled" ]]
+	then
+		echo "Not able to enable taskname sysdata append. Configfs not available in ${NETCONS_PATH}/userdata/taskname_enabled" >&2
+		exit "${ksft_skip}"
+	fi
+
+	echo 1 > "${NETCONS_PATH}/userdata/taskname_enabled"
+}
+
 # Disable the sysdata cpu_nr feature
 function unset_cpu_nr() {
 	echo 0 > "${NETCONS_PATH}/userdata/cpu_nr_enabled"
 }
 
-# Test if MSG content and `cpu=${CPU}` exists in OUTPUT_FILE
-function validate_sysdata_cpu_exists() {
+# Once called, taskname=<..> will not be appended anymore
+function unset_taskname() {
+	echo 0 > "${NETCONS_PATH}/userdata/taskname_enabled"
+}
+
+# Test if MSG contains sysdata
+function validate_sysdata() {
 	# OUTPUT_FILE will contain something like:
 	# 6.11.1-0_fbk0_rc13_509_g30d75cea12f7,13,1822,115075213798,-;netconsole selftest: netcons_gtJHM
 	#  userdatakey=userdatavalue
 	#  cpu=X
+	#  taskname=<taskname>
+
+	# Echo is what this test uses to create the message. See runtest()
+	# function
+	SENDER="echo"
 
 	if [ ! -f "$OUTPUT_FILE" ]; then
 		echo "FAIL: File was not generated." >&2
@@ -62,12 +83,19 @@ function validate_sysdata_cpu_exists() {
 		exit "${ksft_fail}"
 	fi
 
+	if ! grep -q "taskname=${SENDER}" "${OUTPUT_FILE}"; then
+		echo "FAIL: 'taskname=echo' not found in ${OUTPUT_FILE}" >&2
+		cat "${OUTPUT_FILE}" >&2
+		exit "${ksft_fail}"
+	fi
+
 	rm "${OUTPUT_FILE}"
 	pkill_socat
 }
 
-# Test if MSG content exists in OUTPUT_FILE but no `cpu=` string
-function validate_sysdata_no_cpu() {
+# Test if MSG content exists in OUTPUT_FILE but no `cpu=` and `taskname=`
+# strings
+function validate_no_sysdata() {
 	if [ ! -f "$OUTPUT_FILE" ]; then
 		echo "FAIL: File was not generated." >&2
 		exit "${ksft_fail}"
@@ -85,6 +113,12 @@ function validate_sysdata_no_cpu() {
 		exit "${ksft_fail}"
 	fi
 
+	if grep -q "taskname=" "${OUTPUT_FILE}"; then
+		echo "FAIL: 'taskname=  found in ${OUTPUT_FILE}" >&2
+		cat "${OUTPUT_FILE}" >&2
+		exit "${ksft_fail}"
+	fi
+
 	rm "${OUTPUT_FILE}"
 }
 
@@ -133,10 +167,12 @@ OUTPUT_FILE="/tmp/${TARGET}_1"
 MSG="Test #1 from CPU${CPU}"
 # Enable the auto population of cpu_nr
 set_cpu_nr
+# Enable taskname to be appended to sysdata
+set_taskname
 runtest
 # Make sure the message was received in the dst part
 # and exit
-validate_sysdata_cpu_exists
+validate_sysdata
 
 #====================================================
 # TEST #2
@@ -148,7 +184,7 @@ OUTPUT_FILE="/tmp/${TARGET}_2"
 MSG="Test #2 from CPU${CPU}"
 set_user_data
 runtest
-validate_sysdata_cpu_exists
+validate_sysdata
 
 # ===================================================
 # TEST #3
@@ -160,8 +196,9 @@ OUTPUT_FILE="/tmp/${TARGET}_3"
 MSG="Test #3 from CPU${CPU}"
 # Enable the auto population of cpu_nr
 unset_cpu_nr
+unset_taskname
 runtest
 # At this time, cpu= shouldn't be present in the msg
-validate_sysdata_no_cpu
+validate_no_sysdata
 
 exit "${ksft_pass}"

-- 
2.43.5


^ permalink raw reply related	[flat|nested] 12+ messages in thread

* Re: [PATCH net-next v2 2/8] netconsole: Make boolean comparison consistent
  2025-02-28 12:50 ` [PATCH net-next v2 2/8] netconsole: Make boolean comparison consistent Breno Leitao
@ 2025-03-04 11:50   ` Simon Horman
  0 siblings, 0 replies; 12+ messages in thread
From: Simon Horman @ 2025-03-04 11:50 UTC (permalink / raw)
  To: Breno Leitao
  Cc: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Jonathan Corbet, Shuah Khan, netdev, linux-kernel,
	linux-doc, linux-kselftest, kernel-team

On Fri, Feb 28, 2025 at 04:50:18AM -0800, Breno Leitao wrote:
> Convert the current state assignment to use explicit boolean conversion,
> making the code more robust and easier to read. This change adds a
> double-negation operator to ensure consistent boolean conversion as
> suggested by Paolo[1].
> 
> This approach aligns with the existing pattern used in
> sysdata_cpu_nr_enabled_show().
> 
> Link: https://lore.kernel.org/all/7309e760-63b0-4b58-ad33-2fb8db361141@redhat.com/ [1]
> Signed-off-by: Breno Leitao <leitao@debian.org>

Thanks Breno,

FWIIW, I 100% agree with this change.

Reviewed-by: Simon Horman <horms@kernel.org>

^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH net-next v2 6/8] netconsole: add task name to extra data fields
  2025-02-28 12:50 ` [PATCH net-next v2 6/8] netconsole: add task name to extra data fields Breno Leitao
@ 2025-03-04 11:52   ` Simon Horman
  0 siblings, 0 replies; 12+ messages in thread
From: Simon Horman @ 2025-03-04 11:52 UTC (permalink / raw)
  To: Breno Leitao
  Cc: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Jonathan Corbet, Shuah Khan, netdev, linux-kernel,
	linux-doc, linux-kselftest, kernel-team

On Fri, Feb 28, 2025 at 04:50:22AM -0800, Breno Leitao wrote:
> This is the core patch for this whole patchset. Add support for
> including the current task's name in netconsole's extra data output.
> This adds a new append_taskname() function that writes the task name
> (from current->comm) into the target's extradata buffer, similar to how
> CPU numbers are handled.
> 
> The task name is included when the SYSDATA_TASKNAME field is set,
> appearing in the format "taskname=<name>" in the output. This additional
> context can help with debugging by showing which task generated each
> console message.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Simon Horman <horms@kernel.org>


^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support
  2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
                   ` (7 preceding siblings ...)
  2025-02-28 12:50 ` [PATCH net-next v2 8/8] netconsole: selftest: add task name append testing Breno Leitao
@ 2025-03-04 14:50 ` patchwork-bot+netdevbpf
  8 siblings, 0 replies; 12+ messages in thread
From: patchwork-bot+netdevbpf @ 2025-03-04 14:50 UTC (permalink / raw)
  To: Breno Leitao
  Cc: andrew+netdev, davem, edumazet, kuba, pabeni, horms, corbet,
	shuah, netdev, linux-kernel, linux-doc, linux-kselftest,
	kernel-team

Hello:

This series was applied to netdev/net-next.git (main)
by Paolo Abeni <pabeni@redhat.com>:

On Fri, 28 Feb 2025 04:50:16 -0800 you wrote:
> This patchset introduces a new feature to the netconsole extradata
> subsystem that enables the inclusion of the current task's name in the
> sysdata output of netconsole messages.
> 
> This enhancement is particularly valuable for large-scale deployments,
> such as Meta's, where netconsole collects messages from millions of
> servers and stores them in a data warehouse for analysis. Engineers
> often rely on these messages to investigate issues and assess kernel
> health.
> 
> [...]

Here is the summary with links:
  - [net-next,v2,1/8] netconsole: prefix CPU_NR sysdata feature with SYSDATA_
    https://git.kernel.org/netdev/net-next/c/8a683295c226
  - [net-next,v2,2/8] netconsole: Make boolean comparison consistent
    https://git.kernel.org/netdev/net-next/c/efb878fbe8d1
  - [net-next,v2,3/8] netconsole: refactor CPU number formatting into separate function
    https://git.kernel.org/netdev/net-next/c/4d989521a93b
  - [net-next,v2,4/8] netconsole: add taskname to extradata entry count
    https://git.kernel.org/netdev/net-next/c/33e4b29f2b3b
  - [net-next,v2,5/8] netconsole: add configfs controls for taskname sysdata feature
    https://git.kernel.org/netdev/net-next/c/09e877590bc2
  - [net-next,v2,6/8] netconsole: add task name to extra data fields
    https://git.kernel.org/netdev/net-next/c/dd30ae533242
  - [net-next,v2,7/8] netconsole: docs: document the task name feature
    https://git.kernel.org/netdev/net-next/c/7010b619830f
  - [net-next,v2,8/8] netconsole: selftest: add task name append testing
    https://git.kernel.org/netdev/net-next/c/d7a2522426e8

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



^ permalink raw reply	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2025-03-04 14:50 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-02-28 12:50 [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support Breno Leitao
2025-02-28 12:50 ` [PATCH net-next v2 1/8] netconsole: prefix CPU_NR sysdata feature with SYSDATA_ Breno Leitao
2025-02-28 12:50 ` [PATCH net-next v2 2/8] netconsole: Make boolean comparison consistent Breno Leitao
2025-03-04 11:50   ` Simon Horman
2025-02-28 12:50 ` [PATCH net-next v2 3/8] netconsole: refactor CPU number formatting into separate function Breno Leitao
2025-02-28 12:50 ` [PATCH net-next v2 4/8] netconsole: add taskname to extradata entry count Breno Leitao
2025-02-28 12:50 ` [PATCH net-next v2 5/8] netconsole: add configfs controls for taskname sysdata feature Breno Leitao
2025-02-28 12:50 ` [PATCH net-next v2 6/8] netconsole: add task name to extra data fields Breno Leitao
2025-03-04 11:52   ` Simon Horman
2025-02-28 12:50 ` [PATCH net-next v2 7/8] netconsole: docs: document the task name feature Breno Leitao
2025-02-28 12:50 ` [PATCH net-next v2 8/8] netconsole: selftest: add task name append testing Breno Leitao
2025-03-04 14:50 ` [PATCH net-next v2 0/8] netconsole: Add taskname sysdata support patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).