cmake: Add support for global overlay config file #15669

jukkar · 2019-04-25T11:42:03Z

If OVERLAY_CONFIG_DIRS environment variable is specified, then
search it if the file in OVERLAY_CONFIG is not found.

Example:

$ cd samples/net/ipv4_autoconf
$ OVERLAY_CONFIG_DIRS=../sockets/echo_server
cmake -B build -DBOARD=qemu_x86 -DOVERLAY_CONFIG=overlay-e1000.conf .

Zephyr version: 1.14.99
-- Selected BOARD qemu_x86
-- Found west: west (found version "0.5.6", minimum required is "0.5.6")
-- Loading zephyr/boards/x86/qemu_x86/qemu_x86.dts as base
-- Overlaying zephyr/dts/common/common.dts
-- Overlaying ../sockets/echo_server/overlay-e1000.conf
Parsing Kconfig tree in zephyr/Kconfig

So in this example the samples/net/ipv4_autoconf directory does
not contain overlay-e1000.conf, but it is found in
../sockets/echo_server/ directory which is mentioned in
OVERLAY_CONFIG_DIRS variable.

Fixes #14740

Signed-off-by: Jukka Rissanen [email protected]

If OVERLAY_CONFIG_DIRS environment variable is specified, then search it if the file in OVERLAY_CONFIG is not found. Example: $ cd samples/net/ipv4_autoconf $ OVERLAY_CONFIG_DIRS=../sockets/echo_server \ cmake -B build -DBOARD=qemu_x86 -DOVERLAY_CONFIG=overlay-e1000.conf . Zephyr version: 1.14.99 -- Selected BOARD qemu_x86 -- Found west: west (found version "0.5.6", minimum required is "0.5.6") -- Loading zephyr/boards/x86/qemu_x86/qemu_x86.dts as base -- Overlaying zephyr/dts/common/common.dts -- Overlaying ../sockets/echo_server/overlay-e1000.conf Parsing Kconfig tree in zephyr/Kconfig So in this example the samples/net/ipv4_autoconf directory does not contain overlay-e1000.conf, but it is found in ../sockets/echo_server/ directory which is mentioned in OVERLAY_CONFIG_DIRS variable. Fixes zephyrproject-rtos#14740 Signed-off-by: Jukka Rissanen <[email protected]>

jukkar · 2019-04-25T11:43:28Z

If this is acceptable, then we can define where the global config overlays could be placed and I can do more updates to documentation etc.

SebastianBoe · 2019-04-25T11:56:38Z

Should we have this behave and be named, like BOARD_ROOT, and DTS_BINDINGS_ROOT?

So we have a list that contains an in-tree directory, and also any other directories that are appended by the user.

SebastianBoe · 2019-04-25T11:58:56Z

cmake/kconfig.cmake

@@ -104,6 +104,38 @@ if(EXTRA_KCONFIG_OPTIONS)
    )
 endif()

+# Set overlay config files list using a list of directories where the
+# overlay files could be found.
+if(DEFINED ENV{OVERLAY_CONFIG_DIRS})


If we support env vars, we should also support setting this through a CMake var.

SebastianBoe · 2019-04-25T11:59:59Z

cmake/kconfig.cmake

+  endforeach()
+else()
+  set(overlay_config_files ${OVERLAY_CONFIG_AS_LIST})
+endif()


The application docs need updating.

https://docs.zephyrproject.org/latest/application/index.html

SebastianBoe · 2019-04-25T12:03:28Z

cmake/kconfig.cmake

+
+  # We add current directory first so that it is seached first
+  set(overlay_config_dir_list ".:${OVERLAY_CONFIG_DIRS}")
+  string(REPLACE ":" ";" overlay_config_dirs "${overlay_config_dir_list}")


: is used in Windows (C:), use '|' instead.

Or maybe ' ' ?

I was following the way directories are separated in PATH in unix.

Right, but we need to also support Windows.

Sure, we should just figure out what separator to use. Probably not space as that could be part of file or directory. Perhaps ";" could be used?

I'd prefer to use what we are already using, and that is whitespace.

https://github.com/zephyrproject-rtos/zephyr/pull/15669/files/f27c6b30e2229c3710b242482ae89e1904f53b85#diff-3a17f68c7317a0565fa6d10ecdd67c05R26

We can't have every user-settable list use a different separator.

SebastianBoe · 2019-04-25T12:17:45Z

cmake/kconfig.cmake

+    else()
+      set(found 0)
+      foreach(d ${overlay_config_dirs})
+        if(EXISTS ${d}/${f} AND NOT IS_DIRECTORY ${d}/${f})


Isn't it a user-error for d/f to be a directory?

Can we ignore or error-out on this case instead?

SebastianBoe · 2019-04-25T12:18:32Z

cmake/kconfig.cmake

+      set(found 0)
+      foreach(d ${overlay_config_dirs})
+        if(EXISTS ${d}/${f} AND NOT IS_DIRECTORY ${d}/${f})
+          message(STATUS "Overlaying ${d}/${f}")


Doesn't kconfig.py spit this out?

I did not see it doing that.

Loading /home/sebo/ncs/zephyr/boards/arm/nrf9160_pca10090/nrf9160_pca10090_defconfig as base
Merging /home/sebo/ncs/zephyr/samples/hello_world/prj.conf

The system definitely does not print anything for the overlay config file atm.

That is strange, can you find out why?

Perhaps it is being omitted.

SebastianBoe · 2019-04-25T12:19:55Z

cmake/kconfig.cmake

+        endif()
+      endforeach()
+      if(NOT found)
+        # Let the file checker below to report error


I don't know what this means.

What I meant by this comment, is that in about 20-30 lines below in this file, there is a checker that makes sure that the config fragment file exists (search message(FATAL_ERROR "File not found: ${f}")). So we do not bail out here if the file is not found as that is checked later in this file anyway.

SebastianBoe · 2019-04-25T12:21:43Z

cmake/kconfig.cmake

+      endif()
+    endif()
+  endforeach()
+else()


Do you need this if-else?

Wouldn't technically . be the highest priority, and therefore the files be appended correctly to overlay_config_files ?

Yes, that else() could be removed if needed. Just tried to optimize this a bit so that the default case (no OVERLAY_CONFIG_DIRS defined) would work just like now.

Let's get rid of the if-else, this would be consistent with BOARD_ROOT and DTS_BINDINGS_ROOT.

SebastianBoe · 2019-04-25T12:23:35Z

An in-tree common directory of Kconfig fragments sounds sane.

mike-scott · 2019-04-25T16:24:21Z

Having to set an env var seems a bit tedious. Were we planning on having a default setting / location?

jukkar · 2019-04-25T18:26:31Z

Having to set an env var seems a bit tedious. Were we planning on having a default setting / location?

It would be nice if not all default overlay config files are in same directory. What I mean by this is that for example in networking case, it would make lot of sense if we could place network related overlays in network specific directory etc.

SebastianBoe · 2019-04-26T07:52:46Z

It would be nice if not all default overlay config files are in same directory. What I mean by this is that for example in networking case, it would make lot of sense if we could place network related overlays in network specific directory etc.

Wouldn't this be solved by marti's suggestion;

#14740 (comment)

of defaulting to including zephyr/kconfig/common,

and then doing

OVERLAY_CONFIG=subsys/net/ieee/foo.conf

?

foo.conf would be in

zephyr/kconfig/common/subsys/net/ieee/foo.conf

rlubos · 2019-05-06T13:50:25Z

Do I understand correctly, that with the current approach we apply either local overlay config or the global one, with the location specified in OVERLAY_CONFIG_DIRS, not both?

I'm asking, because looking at various overlay files, it's quite common to see that they contain a common part and sample-specific tweaks. For instance, most of the overlay-bt.conf are almost identical, differentiating only on the CONFIG_BT_DEVICE_NAME. Same story with overlay-ot.conf - they only differ in IP address configuration. Perhaps it would be beneficial that such tweaks could be applied in local overlay config, and then both overlays applied on the original configuration?

jukkar · 2019-10-24T18:31:21Z

Closing this as I do not have time to work on this. Feel free to use the code and ideas as needed.

jukkar added the area: Build System label Apr 25, 2019

jukkar requested review from nashif and SebastianBoe April 25, 2019 11:42

jukkar requested a review from pfalcon April 25, 2019 11:43

SebastianBoe reviewed Apr 25, 2019

View reviewed changes

SebastianBoe added the RFC Request For Comments: want input from the community label Apr 25, 2019

SebastianBoe reviewed Apr 25, 2019

View reviewed changes

jukkar added area: Configuration System area: Kconfig labels Apr 25, 2019

jukkar closed this Oct 24, 2019

jukkar deleted the bug-14740-global-overlays branch February 29, 2024 08:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmake: Add support for global overlay config file #15669

cmake: Add support for global overlay config file #15669

jukkar commented Apr 25, 2019

jukkar commented Apr 25, 2019

SebastianBoe commented Apr 25, 2019 •

edited

Loading

SebastianBoe Apr 25, 2019

SebastianBoe Apr 25, 2019

SebastianBoe Apr 25, 2019

SebastianBoe Apr 25, 2019

jukkar Apr 25, 2019

SebastianBoe Apr 25, 2019

jukkar Apr 25, 2019

SebastianBoe Apr 25, 2019

SebastianBoe Apr 25, 2019

SebastianBoe Apr 25, 2019

jukkar Apr 25, 2019

SebastianBoe Apr 25, 2019

jukkar Apr 25, 2019

SebastianBoe Apr 25, 2019

SebastianBoe Apr 25, 2019

jukkar Apr 25, 2019

SebastianBoe Apr 25, 2019

jukkar Apr 25, 2019

SebastianBoe Apr 25, 2019

SebastianBoe commented Apr 25, 2019

mike-scott commented Apr 25, 2019

jukkar commented Apr 25, 2019

SebastianBoe commented Apr 26, 2019 •

edited

Loading

rlubos commented May 6, 2019

jukkar commented Oct 24, 2019

cmake: Add support for global overlay config file #15669

cmake: Add support for global overlay config file #15669

Conversation

jukkar commented Apr 25, 2019

jukkar commented Apr 25, 2019

SebastianBoe commented Apr 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SebastianBoe commented Apr 25, 2019

mike-scott commented Apr 25, 2019

jukkar commented Apr 25, 2019

SebastianBoe commented Apr 26, 2019 • edited Loading

rlubos commented May 6, 2019

jukkar commented Oct 24, 2019

SebastianBoe commented Apr 25, 2019 •

edited

Loading

SebastianBoe commented Apr 26, 2019 •

edited

Loading