Skip to contentSkip to conversation

netconsole: reuse netpoll_parse_ip_addr in configfs helpers

PATCH Superseded Breno Leitao 2 participants 14 messages Jul 21, 2025 – Jul 24, 2025

Subsystems (3)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Breno Leitao

author maintainer
#0 lore raw

v2 cover netconsole: reuse netpoll_parse_ip_addr in configfs helpers

This patchset refactors the IP address parsing logic in the netconsole driver to eliminate code duplication and improve maintainability. The changes centralize IPv4 and IPv6 address parsing into a single function (netpoll_parse_ip_addr). For that, it needs to teach netpoll_parse_ip_addr() to handle strings with newlines, which is the type of string coming from configfs.

Background

The netconsole driver currently has duplicate IP address parsing logic in both local_ip_store() and remote_ip_store() functions. This duplication increases the risk of inconsistencies and makes the code harder to maintain.

Benefits

* Reduced code duplication: ~40 lines of duplicate parsing logic eliminated
* Improved robustness: Centralized parsing reduces the chance of inconsistencies
* Easier to maintain: Code follow more the netdev way

PS: The patches are very well contained in other to help review.

---
Changes in v2:
- Moved the netpoll_parse_ip_addr() to outside the dynamic block (Jakub)
- Link to v1: https://lore.kernel.org/r/[email protected]

---
Breno Leitao (5):
netpoll: Remove unused fields from inet_addr union
netconsole: move netpoll_parse_ip_addr() earlier for reuse
netconsole: add support for strings with new line in netpoll_parse_ip_addr
netconsole: use netpoll_parse_ip_addr in local_ip_store
netconsole: use netpoll_parse_ip_addr in local_ip_store

 drivers/net/netconsole.c | 85 ++++++++++++++++++------------------------------
 include/linux/netpoll.h  |  3 --
 2 files changed, 31 insertions(+), 57 deletions(-)

---
base-commit: d61f6cb6f6ef3c70d2ccc0d9c85c508cb8017da9
change-id: 20250718-netconsole_ref-c1f7254cfb51

Best regards,

Signature · 1 line
Breno Leitao <[email protected]>
author maintainer
#1 lore raw

PATCH v2 1/5 netpoll: Remove unused fields from inet_addr union

Clean up the inet_addr union by removing unused fields that are redundant with existing members:

This simplifies the union structure while maintaining all necessary functionality for both IPv4 and IPv6 address handling.

---
 include/linux/netpoll.h | 3 ---
 1 file changed, 3 deletions(-)
include/linux/netpoll.h +0 -3
index 735e65c3cc114..b5ea9882eda8b 100644
@@ -15,10 +15,7 @@
 #include <linux/refcount.h>
 
 union inet_addr {
-	__u32		all[4];
 	__be32		ip;
-	__be32		ip6[4];
-	struct in_addr	in;
 	struct in6_addr	in6;
 };
 
Signature · 1 line
2.47.1
reviewer Reviewed-by on v2 1/5
#2 lore raw

Re: [PATCH net-next v2 1/5] netpoll: Remove unused fields from inet_addr union

Quoted 7 lines · Breno Leitao

Clean up the inet_addr union by removing unused fields that are redundant with existing members:

This simplifies the union structure while maintaining all necessary functionality for both IPv4 and IPv6 address handling.

author maintainer
#3 lore raw

PATCH v2 2/5 netconsole: move netpoll_parse_ip_addr() earlier for reuse

In reply to Breno Leitao

Move netpoll_parse_ip_addr() earlier in the file to be reused in other functions, such as local_ip_store(). This avoids duplicate address parsing logic and centralizes validation for both IPv4 and IPv6 string input.

No functional changes intended.

---
 drivers/net/netconsole.c | 40 ++++++++++++++++++++--------------------
 1 file changed, 20 insertions(+), 20 deletions(-)
drivers/net/netconsole.c +20 -20
index e3722de08ea9f..8d1b93264e0fd 100644
@@ -300,6 +300,26 @@ static void netconsole_print_banner(struct netpoll *np)
 	np_info(np, "remote ethernet address %pM\n", np->remote_mac);
 }
 
+static int netpoll_parse_ip_addr(const char *str, union inet_addr *addr)
+{
+	const char *end;
+
+	if (!strchr(str, ':') &&
+	    in4_pton(str, -1, (void *)addr, -1, &end) > 0) {
+		if (!*end)
+			return 0;
+	}
+	if (in6_pton(str, -1, addr->in6.s6_addr, -1, &end) > 0) {
+#if IS_ENABLED(CONFIG_IPV6)
+		if (!*end)
+			return 1;
+#else
+		return -1;
+#endif
+	}
+	return -1;
+}
+
 #ifdef	CONFIG_NETCONSOLE_DYNAMIC
 
 /*
@@ -1742,26 +1762,6 @@ static void write_msg(struct console *con, const char *msg, unsigned int len)
 	spin_unlock_irqrestore(&target_list_lock, flags);
 }
 
-static int netpoll_parse_ip_addr(const char *str, union inet_addr *addr)
-{
-	const char *end;
-
-	if (!strchr(str, ':') &&
-	    in4_pton(str, -1, (void *)addr, -1, &end) > 0) {
-		if (!*end)
-			return 0;
-	}
-	if (in6_pton(str, -1, addr->in6.s6_addr, -1, &end) > 0) {
-#if IS_ENABLED(CONFIG_IPV6)
-		if (!*end)
-			return 1;
-#else
-		return -1;
-#endif
-	}
-	return -1;
-}
-
 static int netconsole_parser_cmdline(struct netpoll *np, char *opt)
 {
 	bool ipversion_set = false;
Signature · 1 line
2.47.1
reviewer Reviewed-by on v2 2/5
#4 lore raw

Re: [PATCH net-next v2 2/5] netconsole: move netpoll_parse_ip_addr() earlier for reuse

Quoted 8 lines · Breno Leitao

Move netpoll_parse_ip_addr() earlier in the file to be reused in other functions, such as local_ip_store(). This avoids duplicate address parsing logic and centralizes validation for both IPv4 and IPv6 string input.

No functional changes intended.

author maintainer
#5 lore raw

PATCH v2 3/5 netconsole: add support for strings with new line in netpoll_parse_ip_addr

In reply to Breno Leitao

The current IP address parsing logic fails when the input string contains a trailing newline character. This can occur when IP addresses are provided through configfs, which contains newlines in a const buffer.

Teach netpoll_parse_ip_addr() how to ignore newlines at the end of the IPs. Also, simplify the code by:

* No need to check for separators. Try to parse ipv4, if it fails try ipv6 similarly to ceph_pton()
* If ipv6 is not supported, don't call in6_pton() at all.

---
 drivers/net/netconsole.c | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)
drivers/net/netconsole.c +12 -11
index 8d1b93264e0fd..f2c2b8852c603 100644
@@ -303,20 +303,21 @@ static void netconsole_print_banner(struct netpoll *np)
 static int netpoll_parse_ip_addr(const char *str, union inet_addr *addr)
 {
 	const char *end;
+	int len;
 
-	if (!strchr(str, ':') &&
-	    in4_pton(str, -1, (void *)addr, -1, &end) > 0) {
-		if (!*end)
-			return 0;
-	}
-	if (in6_pton(str, -1, addr->in6.s6_addr, -1, &end) > 0) {
-#if IS_ENABLED(CONFIG_IPV6)
-		if (!*end)
-			return 1;
-#else
+	len = strlen(str);
+	if (!len)
 		return -1;
+
+	if (str[len - 1] == '\n')
+		len -= 1;
+
+	if (in4_pton(str, len, (void *)addr, -1, &end) > 0)
+		return 0;
+#if IS_ENABLED(CONFIG_IPV6)
+	if (in6_pton(str, len, addr->in6.s6_addr, -1, &end) > 0)
+		return 1;
 #endif
-	}
 	return -1;
 }
 
Signature · 1 line
2.47.1
reviewer Reviewed-by on v2 3/5
#6 lore raw

Re: [PATCH net-next v2 3/5] netconsole: add support for strings with new line in netpoll_parse_ip_addr

Quoted 5 lines · Breno Leitao

The current IP address parsing logic fails when the input string contains a trailing newline character. This can occur when IP addresses are provided through configfs, which contains newlines in a const buffer.

Quoted 8 lines

Teach netpoll_parse_ip_addr() how to ignore newlines at the end of the IPs. Also, simplify the code by:

* No need to check for separators. Try to parse ipv4, if it fails try ipv6 similarly to ceph_pton()
* If ipv6 is not supported, don't call in6_pton() at all.

My suggestion below not withstanding, this looks good to me.

Quoted 27 lines
---
 drivers/net/netconsole.c | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)
drivers/net/netconsole.c +3 -10
index 8d1b93264e0fd..f2c2b8852c603 100644
@@ -303,20 +303,21 @@ static void netconsole_print_banner(struct netpoll *np)
 static int netpoll_parse_ip_addr(const char *str, union inet_addr *addr)
 {
 	const char *end;
+	int len;
 
-	if (!strchr(str, ':') &&
-	    in4_pton(str, -1, (void *)addr, -1, &end) > 0) {
-		if (!*end)
-			return 0;
-	}
-	if (in6_pton(str, -1, addr->in6.s6_addr, -1, &end) > 0) {
-#if IS_ENABLED(CONFIG_IPV6)
-		if (!*end)
-			return 1;
-#else
+	len = strlen(str);
+	if (!len)
 		return -1;

drivers/net/netconsole.c static void netconsole_print_banner(struct netpoll *np) · line 320

Quoted 10 lines
drivers/net/netconsole.c +9 -0
+
+	if (str[len - 1] == '\n')
+		len -= 1;
+
+	if (in4_pton(str, len, (void *)addr, -1, &end) > 0)
+		return 0;
+#if IS_ENABLED(CONFIG_IPV6)
+	if (in6_pton(str, len, addr->in6.s6_addr, -1, &end) > 0)
+		return 1;
 #endif

I don't think it needs to block progress.
But FWIIW, I think it would be nice to increase
build coverage and express this as:

	if (IS_ENABLED(CONFIG_IPV6) &&
	    in6_pton(str, len, addr->in6.s6_addr, -1, &end) > 0)
		return 1;
author maintainer
#7 lore raw

Re: [PATCH net-next v2 3/5] netconsole: add support for strings with new line in netpoll_parse_ip_addr

Quoted 29 lines · Simon Horman
Quoted 27 lines · Breno Leitao
drivers/net/netconsole.c +9 -10
@@ -303,20 +303,21 @@ static void netconsole_print_banner(struct netpoll *np)
 static int netpoll_parse_ip_addr(const char *str, union inet_addr *addr)
 {
 	const char *end;
+	int len;
 
-	if (!strchr(str, ':') &&
-	    in4_pton(str, -1, (void *)addr, -1, &end) > 0) {
-		if (!*end)
-			return 0;
-	}
-	if (in6_pton(str, -1, addr->in6.s6_addr, -1, &end) > 0) {
-#if IS_ENABLED(CONFIG_IPV6)
-		if (!*end)
-			return 1;
-#else
+	len = strlen(str);
+	if (!len)
 		return -1;
+
+	if (str[len - 1] == '\n')
+		len -= 1;
+
+	if (in4_pton(str, len, (void *)addr, -1, &end) > 0)
+		return 0;
Quoted 8 lines

drivers/net/netconsole.c static void netconsole_print_banner(struct netpoll *np) · line 320

Quoted 4 lines
drivers/net/netconsole.c +3 -0
+#if IS_ENABLED(CONFIG_IPV6)
+	if (in6_pton(str, len, addr->in6.s6_addr, -1, &end) > 0)
+		return 1;
 #endif

I don't think it needs to block progress.
But FWIIW, I think it would be nice to increase
build coverage and express this as:

Agree. While testing with IPv6 disabled, the netcons selftest exploded, so, this explose a bug in the selftest. This is now fixed in:

	https://lore.kernel.org/all/[email protected]/

Thanks for the review,
--breno

reviewer
#8 lore raw

Re: [PATCH net-next v2 3/5] netconsole: add support for strings with new line in netpoll_parse_ip_addr

Quoted 39 lines · Breno Leitao
Quoted 29 lines · Simon Horman
Quoted 27 lines · Breno Leitao
drivers/net/netconsole.c +9 -10
@@ -303,20 +303,21 @@ static void netconsole_print_banner(struct netpoll *np)
 static int netpoll_parse_ip_addr(const char *str, union inet_addr *addr)
 {
 	const char *end;
+	int len;
 
-	if (!strchr(str, ':') &&
-	    in4_pton(str, -1, (void *)addr, -1, &end) > 0) {
-		if (!*end)
-			return 0;
-	}
-	if (in6_pton(str, -1, addr->in6.s6_addr, -1, &end) > 0) {
-#if IS_ENABLED(CONFIG_IPV6)
-		if (!*end)
-			return 1;
-#else
+	len = strlen(str);
+	if (!len)
 		return -1;
+
+	if (str[len - 1] == '\n')
+		len -= 1;
+
+	if (in4_pton(str, len, (void *)addr, -1, &end) > 0)
+		return 0;
Quoted 8 lines

drivers/net/netconsole.c static void netconsole_print_banner(struct netpoll *np) · line 320

Quoted 4 lines
drivers/net/netconsole.c +3 -0
+#if IS_ENABLED(CONFIG_IPV6)
+	if (in6_pton(str, len, addr->in6.s6_addr, -1, &end) > 0)
+		return 1;
 #endif

I don't think it needs to block progress.
But FWIIW, I think it would be nice to increase
build coverage and express this as:

Quoted 4 lines

Agree. While testing with IPv6 disabled, the netcons selftest exploded, so, this explose a bug in the selftest. This is now fixed in:

	https://lore.kernel.org/all/[email protected]/

Nice, good to find bugs.

author maintainer
#9 lore raw

PATCH v2 4/5 netconsole: use netpoll_parse_ip_addr in local_ip_store

In reply to Breno Leitao

Replace manual IP address parsing with a call to netpoll_parse_ip_addr in local_ip_store(), simplifying the code and reducing the chance of errors.

Also, remove the pr_err() if the user enters an invalid value in configfs entries. pr_err() is not the best way to alert user that the configuration is invalid.

---
 drivers/net/netconsole.c | 22 +++++-----------------
 1 file changed, 5 insertions(+), 17 deletions(-)
drivers/net/netconsole.c +5 -17
index f2c2b8852c603..b24e423a60268 100644
@@ -751,6 +751,7 @@ static ssize_t local_ip_store(struct config_item *item, const char *buf,
 {
 	struct netconsole_target *nt = to_target(item);
 	ssize_t ret = -EINVAL;
+	int ipv6;
 
 	mutex_lock(&dynamic_netconsole_mutex);
 	if (nt->enabled) {
@@ -759,23 +760,10 @@ static ssize_t local_ip_store(struct config_item *item, const char *buf,
 		goto out_unlock;
 	}
 
-	if (strnchr(buf, count, ':')) {
-		const char *end;
-
-		if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
-			if (*end && *end != '\n') {
-				pr_err("invalid IPv6 address at: <%c>\n", *end);
-				goto out_unlock;
-			}
-			nt->np.ipv6 = true;
-		} else
-			goto out_unlock;
-	} else {
-		if (!nt->np.ipv6)
-			nt->np.local_ip.ip = in_aton(buf);
-		else
-			goto out_unlock;
-	}
+	ipv6 = netpoll_parse_ip_addr(buf, &nt->np.local_ip);
+	if (ipv6 == -1)
+		goto out_unlock;
+	nt->np.ipv6 = ipv6;
 
 	ret = strnlen(buf, count);
 out_unlock:
Signature · 1 line
2.47.1
reviewer Reviewed-by on v2 4/5
#10 lore raw

Re: [PATCH net-next v2 4/5] netconsole: use netpoll_parse_ip_addr in local_ip_store

Quoted 9 lines · Breno Leitao

Replace manual IP address parsing with a call to netpoll_parse_ip_addr in local_ip_store(), simplifying the code and reducing the chance of errors.

Also, remove the pr_err() if the user enters an invalid value in configfs entries. pr_err() is not the best way to alert user that the configuration is invalid.

My suggestion below not withstanding, this looks good to me.

Quoted 31 lines
---
 drivers/net/netconsole.c | 22 +++++-----------------
 1 file changed, 5 insertions(+), 17 deletions(-)
drivers/net/netconsole.c +1 -11
index f2c2b8852c603..b24e423a60268 100644
@@ -751,6 +751,7 @@ static ssize_t local_ip_store(struct config_item *item, const char *buf,
 {
 	struct netconsole_target *nt = to_target(item);
 	ssize_t ret = -EINVAL;
+	int ipv6;
 
 	mutex_lock(&dynamic_netconsole_mutex);
 	if (nt->enabled) {
@@ -759,23 +760,10 @@ static ssize_t local_ip_store(struct config_item *item, const char *buf,
 		goto out_unlock;
 	}
 
-	if (strnchr(buf, count, ':')) {
-		const char *end;
-
-		if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
-			if (*end && *end != '\n') {
-				pr_err("invalid IPv6 address at: <%c>\n", *end);
-				goto out_unlock;
-			}
-			nt->np.ipv6 = true;
-		} else
-			goto out_unlock;

drivers/net/netconsole.c static ssize_t local_ip_store(struct config_item *item, const char *buf, · line 766

Quoted 10 lines
drivers/net/netconsole.c +4 -6
-	} else {
-		if (!nt->np.ipv6)
-			nt->np.local_ip.ip = in_aton(buf);
-		else
-			goto out_unlock;
-	}
+	ipv6 = netpoll_parse_ip_addr(buf, &nt->np.local_ip);
+	if (ipv6 == -1)
+		goto out_unlock;
+	nt->np.ipv6 = ipv6;

I don't think this needs to block progress.
And if you disagree that is fine too.
But I would have expressed this as:

	nt->np.ipv6 = !!ipv6;

Because nt->np.ipv6 is a bool and ipv6 is an int.

Likewise for patch 5/5.

...

author maintainer
#11 lore raw

Re: [PATCH net-next v2 4/5] netconsole: use netpoll_parse_ip_addr in local_ip_store

Hello Simon

Quoted 30 lines · Simon Horman
Quoted 15 lines
drivers/net/netconsole.c +0 -11
@@ -759,23 +760,10 @@ static ssize_t local_ip_store(struct config_item *item, const char *buf,
 		goto out_unlock;
 	}
 
-	if (strnchr(buf, count, ':')) {
-		const char *end;
-
-		if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
-			if (*end && *end != '\n') {
-				pr_err("invalid IPv6 address at: <%c>\n", *end);
-				goto out_unlock;
-			}
-			nt->np.ipv6 = true;
-		} else
-			goto out_unlock;

drivers/net/netconsole.c static ssize_t local_ip_store(struct config_item *item, const char *buf, · line 766

Quoted 10 lines
drivers/net/netconsole.c +4 -6
-	} else {
-		if (!nt->np.ipv6)
-			nt->np.local_ip.ip = in_aton(buf);
-		else
-			goto out_unlock;
-	}
+	ipv6 = netpoll_parse_ip_addr(buf, &nt->np.local_ip);
+	if (ipv6 == -1)
+		goto out_unlock;
+	nt->np.ipv6 = ipv6;

I don't think this needs to block progress.
And if you disagree that is fine too.
But I would have expressed this as:

Quoted 5 lines
	nt->np.ipv6 = !!ipv6;

Because nt->np.ipv6 is a bool and ipv6 is an int.

Likewise for patch 5/5.

Agree with the suggestion. I will update the patchset with your suggestion.

Thank you very much for your review, again!
--breno

author maintainer
#12 lore raw

PATCH v2 5/5 netconsole: use netpoll_parse_ip_addr in local_ip_store

In reply to Breno Leitao

Replace manual IP address parsing with a call to netpoll_parse_ip_addr in remote_ip_store(), simplifying the code and reducing the chance of errors.

The error message got removed, since it is not a good practice to pr_err() if used pass a wrong value in configfs.

---
 drivers/net/netconsole.c | 22 +++++-----------------
 1 file changed, 5 insertions(+), 17 deletions(-)
drivers/net/netconsole.c +5 -17
index b24e423a60268..7b394488384ea 100644
@@ -776,6 +776,7 @@ static ssize_t remote_ip_store(struct config_item *item, const char *buf,
 {
 	struct netconsole_target *nt = to_target(item);
 	ssize_t ret = -EINVAL;
+	int ipv6;
 
 	mutex_lock(&dynamic_netconsole_mutex);
 	if (nt->enabled) {
@@ -784,23 +785,10 @@ static ssize_t remote_ip_store(struct config_item *item, const char *buf,
 		goto out_unlock;
 	}
 
-	if (strnchr(buf, count, ':')) {
-		const char *end;
-
-		if (in6_pton(buf, count, nt->np.remote_ip.in6.s6_addr, -1, &end) > 0) {
-			if (*end && *end != '\n') {
-				pr_err("invalid IPv6 address at: <%c>\n", *end);
-				goto out_unlock;
-			}
-			nt->np.ipv6 = true;
-		} else
-			goto out_unlock;
-	} else {
-		if (!nt->np.ipv6)
-			nt->np.remote_ip.ip = in_aton(buf);
-		else
-			goto out_unlock;
-	}
+	ipv6 = netpoll_parse_ip_addr(buf, &nt->np.remote_ip);
+	if (ipv6 == -1)
+		goto out_unlock;
+	nt->np.ipv6 = ipv6;
 
 	ret = strnlen(buf, count);
 out_unlock:
Signature · 1 line
2.47.1
reviewer Reviewed-by on v2 5/5
#13 lore raw

Re: [PATCH net-next v2 5/5] netconsole: use netpoll_parse_ip_addr in local_ip_store

Quoted 8 lines · Breno Leitao

Replace manual IP address parsing with a call to netpoll_parse_ip_addr in remote_ip_store(), simplifying the code and reducing the chance of errors.

The error message got removed, since it is not a good practice to pr_err() if used pass a wrong value in configfs.