netconsole: reuse netpoll_parse_ip_addr in configfs helpers
Subsystems (3)
Breno Leitao
maintainerv4 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
---
Changes in v4:
- Check the end string returned by netpoll_parse_ip_addr(), and fail
if it is different than 0 and \n. (Jakub)
* Also removed Simon reviewed-by given I changed the code slightly.
- Link to v3: https://lore.kernel.org/r/[email protected]
Changes in v3:
- Avoid #ifdef and use if (IS_ENABLED()) instead (Simon)
- Assing an int to a boolean using !! (Simon)
- Link to v2: https://lore.kernel.org/r/[email protected]
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 (4):
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 | 91 ++++++++++++++++++++---------------------------- 1 file changed, 37 insertions(+), 54 deletions(-)
---
base-commit: 37816488247ddddbc3de113c78c83572274b1e2e
change-id: 20250718-netconsole_ref-c1f7254cfb51
Best regards,
Signature · 1 line
Breno Leitao <[email protected]>
Breno Leitao
maintainerPATCH v4 1/4 netconsole: move netpoll_parse_ip_addr() earlier for reuse
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
@@ -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.3
Breno Leitao
maintainerPATCH v4 2/4 netconsole: add support for strings with new line in netpoll_parse_ip_addr
In reply to Breno LeitaoThe 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 | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-)
drivers/net/netconsole.c +20 -13
@@ -300,23 +300,30 @@ static void netconsole_print_banner(struct netpoll *np)np_info (np,"remote ethernet address %pM\n" , np->remote_mac); } +/* Parse the string and populate the `inet_addr` union. Return 0 if IPv4 is +* populated, 1 if IPv6 is populated, and -1 upon failure. +*/ static int netpoll_parse_ip_addr (const char *str,union inet_addr *addr) { -const char *end; +const char *end =NULL ; +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 ; -#endif - } + +if (str[len -1 ] =='\n' ) + len -=1 ; + +if (in4_pton (str, len, (void *)addr,-1 , &end) >0 && + (!end || *end ==0 || *end =='\n' )) +return 0 ; + +if (IS_ENABLED (CONFIG_IPV6 ) && +in6_pton (str, len, (void *)addr,-1 , &end) >0 && + (!end || *end ==0 || *end =='\n' )) +return 1 ; +return -1 ; }
Signature · 1 line
2.47.3
Breno Leitao
maintainerPATCH v4 3/4 netconsole: use netpoll_parse_ip_addr in local_ip_store
In reply to Breno LeitaoReplace 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
@@ -757,6 +757,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) {
@@ -765,23 +766,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.3
Breno Leitao
maintainerPATCH v4 4/4 netconsole: use netpoll_parse_ip_addr in local_ip_store
In reply to Breno LeitaoReplace 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
@@ -782,6 +782,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) {
@@ -790,23 +791,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.3
This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Hello:
This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Quoted 8 lines · On Mon, 11 Aug 2025 11:13:24 -0700 you wrote:
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 teachnetpoll_parse_ip_addr()to handle strings with newlines, which is the type of string coming from configfs.[...]
Here is the summary with links:
- [net-next,v4,1/4] netconsole: move netpoll_parse_ip_addr() earlier for reuse
https://git.kernel.org/netdev/net-next/c/fa38524ca5a7 - [net-next,v4,2/4] netconsole: add support for strings with new line in netpoll_parse_ip_addr https://git.kernel.org/netdev/net-next/c/364213b736e3 - [net-next,v4,3/4] netconsole: use netpoll_parse_ip_addr in local_ip_store https://git.kernel.org/netdev/net-next/c/60cb69214148 - [net-next,v4,4/4] netconsole: use netpoll_parse_ip_addr in local_ip_store https://git.kernel.org/netdev/net-next/c/4aeb452c237a
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html