build-system: generate buildinfo/{app,board,cpu,riotver}.h #21954
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Platform: native
maribu
added
CI: ready for build
Member
Author
|
Note: This needs still an update of the Doxygen doc to account for the dynamically generated headers and an update of the |
Murdock results❌ FAILED 634fdf0 build-system: Pass Build failures (21)
Artifacts |
maribu
force-pushed
the
build-system/buildinfo
branch
2 times, most recently
from
24800cc to
9f0eb1d
Compare
maribu
force-pushed
the
build-system/buildinfo
branch
2 times, most recently
from
0996f97 to
956427e
Compare
maribu
force-pushed
the
build-system/buildinfo
branch
2 times, most recently
from
7574fff to
978b778
Compare
maribu
removed
Area: USB
maribu
force-pushed
the
build-system/buildinfo
branch
from
e43fb84 to
742b6e8
Compare
github-actions
bot
added
Platform: native
External code may assume that RIOT's `sched.h` header is the same as [POSIX's sched.h][1] header. This adds a slim wrapper to not have to patch external code (which in case of glibcxx will be difficult to do). [1]: https://pubs.opengroup.org/onlinepubs/009604299/basedefs/sched.h.html
CPU specific hacks never should go to `core`. This simplifies the hack and moves it to `cpu/native` by providing a custom `sched.h` that adds the workarounds for glibc and adds an `#include_next "sched.h"`. It's a bit of a pity that RIOT's sched.h has a name conflict with POSIX's sched.h - otherwise those hacks wouldn't really be needed.
This changse the build system to expose the board name, the app name, the CPU name, and the RIOT version via dynamically generated headers rather than via `CFLAGS += -D`. The intended goal is to to reduce the entropy of the input of ccache with the hope that for platform independent code, the compiler input to ccache will be often identical for related boards and similar apps. The downside is that code that previously dependent on the macros being predefined by the environment has not to explicitly include the suitable dynamically created header(s). One new macro has also been added: `-DRIOT_OS=1`. Previously a lot of code was checking for `RIOT_VERSION` to compile differently under e.g. Linux and RIOT. The code has been updated to check for `RIOT_OS` instead.
This checks files that use previously globally defined macros without having the correct header included. Also populate GITHUB_RUN_ID in `github_annotate.sh` for compatibility with `set -u`.
This drops the generation of `riotbuild.h` and instead just passes the `-D...` / `-U...` flags via a command line options file to GCC/clang instead. The old `riotbuild.h` now is moved to `core/include` and only contains deprecated aliases and documentation. It is still injected with `-include riotbuild.h`, as otherwise the aliases for dynamic macros injected with `-D` would not be visible.
This adds some `extern char *buildinfo_<NAME>;` to the `riotbuild.h` as alternative to `RIOT_BOARD`, `RIOT_VERSION`, `RIOT_CPU`, and `RIOT_VERSION`. Unlike those macros the object file generated from a compilation unit using the C API do not depend on the actual values, so making them globally available does not impact ccache in any way.
maribu
force-pushed
the
build-system/buildinfo
branch
from
742b6e8 to
d29c445
Compare
Member
Author
|
With https://ci.riot-os.org/details/169027b4b6ff444fb115fedaf0f240bf were are up to 65% cache efficiency on the second build on building For the more realistic test scenario we are still at 0% cache hits: |
AnnsAnns
reviewed
Dec 15, 2025
| include $(RIOTMAKE)/scan-build.inc.mk | ||
|
|
||
| export RIOTBUILD_CONFIG_HEADER_C = $(BINDIR)/riotbuild/riotbuild.h | ||
| export COMPILER_CLI_PARAMS_FILE = $(BINDIR)/ccparams.txt |
Member
There was a problem hiding this comment.
Where does this file come from? I can't find any reference to it anywhere
Member
Author
There was a problem hiding this comment.
That is generated here with those three lines: https://github.com/maribu/RIOT/blob/d29c445c560b778643e38d2fea3f63321b474c6e/Makefile.include#L1028-L1030
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
This changse the build system to expose the board name, the app name, the CPU name, and the RIOT version via dynamically generated headers rather than via
CFLAGS += -D.The intended goal is to to reduce the entropy of the input of ccache with the hope that for platform independent code, the compiler input to ccache will be often identical for related boards and similar apps.
The downside is that code that previously dependent on the macros being predefined by the environment has not to explicitly include the suitable dynamically created header(s).
One new macro has also been added:
-DRIOT_OS=1. Previously a lot of code was checking forRIOT_VERSIONto compile differently under e.g. Linux and RIOT. The code has been updated to check forRIOT_OSinstead.Testing procedure
static-testsfind uses of previously global macrosIssues/PRs references
None