Network stack runtime configuration #97266

jukkar · 2025-10-09T10:11:40Z

Note that this PR is continuing the work started on #68127. Most of the commits come directly from that PR, couple of latest ones are new as they add settings db support.

Executive summary of how the PR works:

create yaml file describing the network configuration
at build time, create a const C struct from this yaml data and compile it to application
at runtime, allow user to tweak the configuration and store changes to settings db
at boot, apply the default and user changed configuration to network subsystem

More detailed description follows:

This PR adds support to autoconfigure the network sub-system when the device boots. It is mainly meant to be used when there are multiple network interfaces in the system. In that case Kconfig based network configure parameters cannot be used easily as the system will only apply the configuration to one of the network interfaces.

This is related to old enhancement #29750 request. There it was pondered to use devicetree to configuring network stack. As DT is only meant to describe hardware configuration some other way of configuration is needed.

This PR uses yaml file to describe network stack configuration. The configuration data in yaml file is not restricted to network configuration but any subsystem configuration could be done via it. I concentrated to network configuration as we need this multi network interface autoconfiguration in networking.

The PR provides minimal infrastructure to validate a user supplied yaml file and then generate a C configuration data file from it. So we do not import the yaml file directly to the zephyr image, but we use a generator script to generate C header file that is then included by the network config library. When the device boots, the network configuration library (subsys/net/lib/config/init.c) reads the configuration stored in flash, and applies the configuration to relevant network interface. When the user creates the yaml file in host system, they should know the network configuration in order to map the yaml file data to the device network configuration. The configuration data from flash is used as a default read-only configuration.

The user supplied yaml file can be stored outside of zephyr. When building the network application, the location of the yaml file is given so the build system can then utilize it.

At runtime, user is able to adjust the configuration values stored in flash. The changes will be stored in settings database, the backend can be selected by the user. The changes to the network configuration can be done via net_config_get/set() API or via a net config shell which provides commands (view/set/remove) to adjust the values in the network configuration. When the device boots, the default network configuration in flash is used as a base and any user changed network configuration values from settings db are applied on top of the default network configuration.

Relates to #77638

scripts/schemas/network-configuration-schema.yml

jukkar · 2025-10-10T13:30:34Z

Converted the schema to jsonschema

jukkar · 2025-10-15T08:14:56Z

@pdgendt compliance checker complains about python code

 Python lint error (I001) see https://docs.astral.sh/ruff/rules/unsorted-imports:Import block is un-sorted or un-formatted
File:scripts/net/net-yaml-config.py
Line:5
Column:1
EndLine:9
EndColumn:12
Compliance error, check for error messages in the "Run Compliance Tests" step

The code looks like this

import hashlib
import os
import re
import sys
import yaml

The code looks correct or am I missing something here?

pdgendt · 2025-10-15T08:44:42Z

The code looks correct or am I missing something here?

There's a distinction between python built-in libraries vs third-party libraries.

You can run the following to fix it:

$ ruff check --fix --select I scripts/net/net-yaml-config.py

pdgendt · 2025-10-15T16:45:08Z

include/zephyr/net/net_config.h

+#if defined(CONFIG_NET_CONFIG_SETTINGS)
+#include <net_init_config.inc>
+#else
+struct net_init_config;


Is this struct generated from the yaml input? If so, almost any change would result in a different sizeof and make it unable to read from the settings subsystem, correct?

I think that's an issue to be able to update your devices.

The size would change only if one changes the schema. There is a hash embedded into the data to detect this and discard the saved data if that happens.

pdgendt · 2025-10-16T06:40:21Z

scripts/net/net-yaml-config.py

I have a similar concern here, like I had in #68127 (comment). Do we want to maintain our own IDL? This code hinges on many external details, and I'm afraid this can break easily.

Not sure how I could make this code / use case more simpler. Introducing nanopb here feels complex, but perhaps I have been too concentrated to supporting the networking use case (testing multiple network interfaces). One big problem when saving user changed data, is the fact that the data is structured i.e., there can be multiple network interfaces, each with additional structured data like IP address etc. Saving this data to flat space like key=value is not very easy, and then we could just do the same with current Kconfig variables.

I do think we should pick up a discussion in the arch meeting first? CC @carlescufi @henrikbrixandersen

You're putting a lot of effort into this, I'd hate it if we can't come to a consensus and let it go to waste (again).

Yes, the plan is to discuss this on next arch meeting on Tue.

jukkar · 2025-10-20T11:28:53Z

Fixed merge conflict
Rebased to latest main to solve the CI issues

carlescufi · 2025-10-30T12:18:13Z

Architecture WG meeting:

If multiple users of the configuration system exist, how do we deal with that? append multiple .yaml files together, or have a single .yaml file?
Should we have multiple levels of hierarchy for those files?
The same applies to schemas, will they be in multiple files?
@henrikbrixandersen suggests that we restrict the scope in the initial contribution as a conscious decision, to avoid the blockage that we hit in the first iterations. Later this can be expanded so that we decide on the points above. The current .yaml file is a single yaml snippet with a top-level
@carlescufi suggest that we change the top-level yaml entry perhaps from net_init_config to networking, with an interfaces entry just below:

net_init_config:
  network_interfaces:

to

networking:
  interfaces:

@carlescufi asks if we should have a top-level config: (or whatever the name we decide as a top-level entry, like manifest: in west.yml
@carlescufi asks also about the name of this feature and file. In New software configuration and provisioning mechanism #77638 there's talk about "software configuration" and "provisioning"
@jukkar and @henrikbrixandersen argue that "provisioning" may not be a good fit for this as it stands now, because that implies non-compile time but rather a pluggable data set that you add to the image later. However, this proposal includes both compile-time configuration and a mechanism to update it/modify it at runtime
If we had not used "settings" already this could actually be a reasonable name for it
Should the questions above be blockers to merge this PR? @henrikbrixandersen suggests to agree whether these are blockers or no, as long as the features is clearly labeled EXPERIMENTAL
@henrikbrixandersen suggest that the current naming scheme be tied to networking itself, so that it can be then expanded with other subsystems using their own names later
@henrikbrixandersen explains that there are area-specific formats for configuration data, and the question arises as to whether we should allow multiple mechanisms in the tree for this or similar purposes. It would then be up to the subsystem to decide whether to extend this proposal or provide their own
@carlescufi suggests that we take this once more to the Tuesday meeting, go over the questions and finally decide on a formulation of a vote in order to move forward

jukkar · 2025-10-30T18:09:27Z

Updated the code according to comments

net_init_config -> networking
network_interfaces -> interfaces
Renamed various files so that they are even more clearly identifiable as being network related
Marked the network config library as experimental as it now uses yaml file. If the user does not create yaml file, then the legacy Kconfig options are used and there is no changes needed from the user.

Add a way to convert a user supplied yaml file to a configuration file. For networking, a C header file is generated which can then be included to the application. Add a cmake function that calls the generate config macros with suitable values for networking needs. Signed-off-by: Jukka Rissanen <[email protected]>

This contains rules to validate network configuration in yaml format. Signed-off-by: Jukka Rissanen <[email protected]>

Add a python script that converts a user supplied network configuration yaml file to a valid network configuration C header file. Signed-off-by: Jukka Rissanen <[email protected]>

If CONFIG_NET_CONFIG_SETTINGS is enabled, then the network configuration library will check if a yaml file network-config.yaml is found in the application directory and use it to generate network initial configuration that is then applied when the device boots. If the yaml file is not there, then the relevant Kconfig options are used to create initial network configuration. Signed-off-by: Jukka Rissanen <[email protected]>

User can set NET_CONFIG_FILE to override the name of the default configuration file name which is network-config.yaml This way a substitute yaml config file can be used instead of the default one. Signed-off-by: Jukka Rissanen <[email protected]>

Example networking yaml configuration file. This contains more complex network setup that can be used to see what can be done. Signed-off-by: Jukka Rissanen <[email protected]>

Add documentation about the network stack configuration using a yaml file. Signed-off-by: Jukka Rissanen <[email protected]>

If user is not interested in the mask length, the value can be set to NULL so that it is not been returned to the caller. Signed-off-by: Jukka Rissanen <[email protected]>

If user has supplied a yaml file, it is used as configuration data that is applied to network configuration. In this case the CONFIG_NET_CONFIG_* Kconfig variables used for configuration are ignored. Signed-off-by: Jukka Rissanen <[email protected]>

Add simple unit tests that verify that options specified in yaml file can be used to configure network stack. Signed-off-by: Jukka Rissanen <[email protected]>

Add set and get functions that return/set either the default settings or if user has changed them, the user adjusted value. Make these two functions to use settings API. Signed-off-by: Jukka Rissanen <[email protected]>

The hash is used to detect whether the yaml schema file is changed. If the data format in the settings is different that what is found in the ROM, then the settings db must be discarded because the data is now incompatible. Signed-off-by: Jukka Rissanen <[email protected]>

Make sure we run the tests with settings db enabled. Signed-off-by: Jukka Rissanen <[email protected]>

Add "net config" command to view the current configuration and modify or remove the configuration data. Signed-off-by: Jukka Rissanen <[email protected]>

Define max length of the IPv6 address as a string without IPv4 mapping. Useful if you have to print IPv6 address string that will never contain IPv4 mapping address. Signed-off-by: Jukka Rissanen <[email protected]>

If ipv4_multicast_address[] is not set in the yaml config file, then compiler may emit this warning which looks like false positive: net/lib/config/init.c: In function 'ipv4_setup.constprop': net/lib/config/init.c:599:67: warning: offset '4294967279' outside bounds of constant string [-Warray-bounds] 599 | ret = parse_mask(ipv4->ipv4_multicast_addresses[j].value, | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~ In file included from zephyr/subsys/net/lib/config/init.c:2028: build/test/zephyr/include/generated/net_init_config.inc:137:37: note: 'net_init_config_data' declared here 137 | static const struct net_init_config net_init_config_data = { | ^~~~~~~~~~~~~~~~~~~~ If user has specified ipv4_multicast_addresses in the yaml file, there is no warning printed. Disable optimization to avoid these warnings. Signed-off-by: Jukka Rissanen <[email protected]>

jukkar · 2025-10-31T08:39:24Z

Rebased to latest main to solve CI issues

sonarqubecloud · 2025-10-31T09:04:04Z

Quality Gate passed

Issues
20 New issues
0 Accepted issues

Measures
1 Security Hotspot
0.0% Coverage on New Code
1.4% Duplication on New Code

See analysis details on SonarQube Cloud

nordicjm · 2025-11-03T14:18:54Z

self ping to remember to review @nordicjm
@jukkar noticed that some builds are failing with flash overflows for hawkbit, one has an 80KiB flash overflow, is that related to the changes here or something that would be fixed in a rebase?

jukkar · 2025-11-04T12:47:55Z

noticed that some builds are failing with flash overflows for hawkbit, one has an 80KiB flash overflow, is that related to the changes here or something that would be fixed in a rebase?

@nordicjm I noticed the same, not sure what is going on there. Most likely something related to this PR, I will look into it after the 4.3 has been released.

nordicjm · 2025-11-05T09:00:44Z

cmake/modules/extensions.cmake

+# from a user supplied yaml file.
+#
+function(generate_config_file
+    source_file           # The yaml source file to be converted to config data


cmake indent is 2 spaces, also the functions are not documented like this in CMake and it goes in the bit above, see https://github.com/zephyrproject-rtos/zephyr/blob/main/cmake/modules/extensions.cmake#L1615 for an example

nordicjm · 2025-11-05T09:05:37Z

cmake/modules/kernel.cmake

+  # If network configuration library is enabled, check if the yaml file
+  # is present and use it to generate an initial configuration. Otherwise
+  # use the .config file to generate the initial configuration.
+  if(EXISTS ${APPLICATION_SOURCE_DIR}/network-config.yaml)


seems like this should be using the zephyr_file() functions so they can pick up e.g. file suffix, also makes me think there should be an option to specify the exact file to use

nordicjm · 2025-11-05T09:06:49Z

cmake/modules/configuration_files.cmake

 zephyr_get(EXTRA_CONF_FILE SYSBUILD LOCAL VAR EXTRA_CONF_FILE OVERLAY_CONFIG MERGE REVERSE)
 zephyr_get(EXTRA_DTC_OVERLAY_FILE SYSBUILD LOCAL MERGE REVERSE)
 zephyr_get(DTS_EXTRA_CPPFLAGS SYSBUILD LOCAL MERGE REVERSE)
+zephyr_get(NET_INIT_CONFIG_FILE)


should be using SYSBUILD LOCAL flags

nordicjm · 2025-11-05T09:07:16Z

doc/connectivity/networking/network_config.rst

+  one network interface that needs to be setup at boot.
+  See available Kconfig options in the network API documentation.
+
+* A yaml configuration file ``network-config.yaml``.


:file:`name`

nordicjm · 2025-11-05T09:07:22Z

doc/connectivity/networking/network_config.rst

+The net-init-config.yaml Syntax
+*******************************
+
+The ``network-config.yaml`` can be placed to the application directory. When the


nordicjm · 2025-11-05T09:08:46Z

subsys/net/lib/config/Kconfig

 source "subsys/net/Kconfig.template.log_config.net"

 menuconfig NET_CONFIG_SETTINGS
 	bool "Set network settings for applications"


Suggested change

bool "Set network settings for applications"

bool "Set network settings for applications [EXPERIMENTAL]"

nordicjm · 2025-11-05T09:17:02Z

include/zephyr/net/net_config.h

+#if defined(CONFIG_NET_CONFIG_SETTINGS)
+#include <network_config.inc>
+#else
+struct networking;


should be a more unique name for this, networking is very plain and non-descriptive

nordicjm · 2025-11-05T09:17:57Z

subsys/net/lib/config/init.c

+	BUILD_ASSERT(sizeof(((struct networking *)0)->interfaces[0].field) >= (size), \
+		     "Field " STRINGIFY(field) " is too small, expecting " STRINGIFY(size) " bytes")
+
+CHECK_FIELD(ipv4.ipv4_addresses[0].value, INET_ADDRSTRLEN + sizeof("/32") - 1);


shouldn't this check if IPV4, IPV6 Kconfigs are enabled?

nordicjm · 2025-11-05T09:18:49Z

subsys/net/lib/config/Kconfig


+config NET_CONFIG_SETTINGS_SHELL_ACCESS
+	bool "Configure options via shell"
+	select SETTINGS


depends on SHELL and depends on SETTINGS (instead)?

nordicjm · 2025-11-05T09:20:01Z

subsys/net/lib/config/CMakeLists.txt

+# Disable optimization for only init.c in order to avoid false
+# positives from bounds checking in optimized builds.
+set_source_files_properties(
+  ${CMAKE_CURRENT_SOURCE_DIR}/init.c
+  PROPERTIES COMPILE_OPTIONS "-O0"
+)


do not think this should be here, should not be adjusting build flags for files

jukkar added the In progress For PRs: is work in progress and should not be merged yet. For issues: Is being worked on label Oct 9, 2025

pdgendt reviewed Oct 9, 2025

View reviewed changes

scripts/schemas/network-configuration-schema.yml Show resolved Hide resolved

jukkar force-pushed the devel/net-config-overhaul branch 4 times, most recently from f5dd020 to 9d1bacb Compare October 15, 2025 07:28

jukkar force-pushed the devel/net-config-overhaul branch 4 times, most recently from 64825cb to 56dd77e Compare October 15, 2025 16:11

pdgendt reviewed Oct 15, 2025

View reviewed changes

pdgendt reviewed Oct 16, 2025

View reviewed changes

jukkar force-pushed the devel/net-config-overhaul branch 2 times, most recently from 8fec811 to 4562de7 Compare October 16, 2025 12:17

jukkar added the Architecture Review Discussion in the Architecture WG required label Oct 16, 2025

github-project-automation bot added this to Architecture Review Oct 16, 2025

github-project-automation bot moved this to Todo in Architecture Review Oct 16, 2025

jukkar force-pushed the devel/net-config-overhaul branch from 4562de7 to 3ae87c6 Compare October 20, 2025 11:28

jukkar force-pushed the devel/net-config-overhaul branch 3 times, most recently from 2159a72 to 438f419 Compare October 21, 2025 07:28

jukkar marked this pull request as ready for review October 21, 2025 15:57

zephyrbot added area: Networking area: IEEE 802.15.4 area: Build System area: Tests Issues related to a particular existing or missing test labels Oct 21, 2025

zephyrbot requested a review from tejlmand October 21, 2025 15:59

zephyrbot assigned rlubos and jukkar Oct 21, 2025

jukkar removed the Architecture Review Discussion in the Architecture WG required label Oct 21, 2025

carlescufi moved this from Todo to In Progress in Architecture Review Oct 28, 2025

jukkar force-pushed the devel/net-config-overhaul branch from 438f419 to 2ad8e9d Compare October 30, 2025 18:05

jukkar added 16 commits October 31, 2025 09:27

schemas: Add network configuration schema yaml file

6f44de2

This contains rules to validate network configuration in yaml format. Signed-off-by: Jukka Rissanen <[email protected]>

net: Add yaml to network configuration generator script

5574488

Add a python script that converts a user supplied network configuration yaml file to a valid network configuration C header file. Signed-off-by: Jukka Rissanen <[email protected]>

net: config: Example yaml configuration file

0605165

Example networking yaml configuration file. This contains more complex network setup that can be used to see what can be done. Signed-off-by: Jukka Rissanen <[email protected]>

doc: net: Add yaml configuration information

4a5a83e

Add documentation about the network stack configuration using a yaml file. Signed-off-by: Jukka Rissanen <[email protected]>

net: utils: Allow user to pass NULL as mask_len

0186249

If user is not interested in the mask length, the value can be set to NULL so that it is not been returned to the caller. Signed-off-by: Jukka Rissanen <[email protected]>

tests: net: config: Add tests for yaml based configuration

871f0bb

Add simple unit tests that verify that options specified in yaml file can be used to configure network stack. Signed-off-by: Jukka Rissanen <[email protected]>

net: config: Add set/get functions

5de847f

Add set and get functions that return/set either the default settings or if user has changed them, the user adjusted value. Make these two functions to use settings API. Signed-off-by: Jukka Rissanen <[email protected]>

tests: net: config: Add settings db testing

b9ce64a

Make sure we run the tests with settings db enabled. Signed-off-by: Jukka Rissanen <[email protected]>

net: shell: config: Add a way to see / modify configuration

f073ae8

Add "net config" command to view the current configuration and modify or remove the configuration data. Signed-off-by: Jukka Rissanen <[email protected]>

net: ip: Add max IPv6 address length define

54628dd

Define max length of the IPv6 address as a string without IPv4 mapping. Useful if you have to print IPv6 address string that will never contain IPv4 mapping address. Signed-off-by: Jukka Rissanen <[email protected]>

jukkar force-pushed the devel/net-config-overhaul branch from 2ad8e9d to 65df8f4 Compare October 31, 2025 08:38

nordicjm reviewed Nov 5, 2025

View reviewed changes

	bool "Set network settings for applications"
	bool "Set network settings for applications [EXPERIMENTAL]"

Network stack runtime configuration #97266

Are you sure you want to change the base?

Network stack runtime configuration #97266

Conversation

jukkar commented Oct 9, 2025 • edited by carlescufi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jukkar commented Oct 10, 2025

Uh oh!

jukkar commented Oct 15, 2025

Uh oh!

pdgendt commented Oct 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jukkar commented Oct 20, 2025

Uh oh!

carlescufi commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jukkar commented Oct 30, 2025

Uh oh!

jukkar commented Oct 31, 2025

Uh oh!

sonarqubecloud bot commented Oct 31, 2025

Quality Gate passed

Uh oh!

nordicjm commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jukkar commented Nov 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jukkar commented Oct 9, 2025 •

edited by carlescufi

Loading

carlescufi commented Oct 30, 2025 •

edited

Loading

nordicjm commented Nov 3, 2025 •

edited

Loading