LLEXT: add discarded symbol groups inspector #99413
Open
+445
−62
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
Move ELF-related utilities from the "llext_prepare_exptab" script to a dedicated "llext_elf_toolkit" which can be reused by other LLEXT scripts. While at it, also improve documentation of class SectionDescriptor. Signed-off-by: Mathieu Choplain <[email protected]>
When the LLEXT subsystem detects that a symbol is marked for export from the main image, but the symbol group in which the export belongs is not enabled, add a marker in a special section in addition to not placing the symbol in the final export table. Add a post-build script which consumes the special section as post-build to dump information about all discarded symbols in a build artifact, and also check for common errors (missing Kconfig symbol / improperly named groups). Signed-off-by: Mathieu Choplain <[email protected]>
zephyrbot
requested review from
57300,
jeremybettis,
lyakh,
nashif,
nordicjm,
pillo79,
teburd and
tejlmand
mathieuchopstm
commented
Nov 14, 2025
Comment on lines
+64
to
+103
| def parse_dotconfig(dotconfig_path: Path): | ||
| """ | ||
| Parses symbols from `.config` file at location 'dotconfig_path'. | ||
|
|
||
| Note: tri-state `"m"` is transformed into integer `2`. | ||
| """ | ||
| # Symbols should receive value 'n' if a line | ||
| # containing 'CONFIG_xxx is not set' is present | ||
| CONFIG_NOT_SET_REGEXP = re.compile(r"# (CONFIG_.+) is not set") | ||
|
|
||
| symbols: dict[str, str | int | bool] = {} | ||
|
|
||
| with dotconfig_path.open("r") as fd: | ||
| for line in fd: | ||
| line = line.strip() | ||
| if len(line) <= 1: | ||
| continue | ||
|
|
||
| # Handle comment lines | ||
| if line[0] == '#': | ||
| if match := CONFIG_NOT_SET_REGEXP.match(line): | ||
| symbols[match.group(1)] = False | ||
| continue | ||
|
|
||
| key, value = line.split("=") | ||
|
|
||
| if value == "y": | ||
| value = True | ||
| elif value == "n": | ||
| value = False | ||
| elif value == "m": | ||
| value = 2 | ||
| elif value[0] == value[-1] == '"': | ||
| value = value.strip('"') | ||
| else: | ||
| value = int(value, base=0) | ||
|
|
||
| symbols[key] = value | ||
|
|
||
| return symbols |
Contributor
Author
There was a problem hiding this comment.
Originally, I thought about using kconfiglib like a good citizen, but it's much less trivial to use than I hoped... c.f.:
zephyr/cmake/modules/kconfig.cmake
Lines 138 to 163 in 9c1fbc8
|
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.
Follow-up to #98990 (c.f. #98990 (comment))
When the LLEXT subsystem detects that a symbol is marked for export from the main image, but the symbol group in which the export belongs is not enabled, add a marker in a special section in addition to not placing the symbol in the final export table.
Add a post-build script which consumes the special section as post-build to dump information about all discarded symbols in a build artifact, and also check for common errors (missing Kconfig symbol / improperly named groups).
While at it, rework LLEXT scripts organization a little bit - maybe a dedicated
scripts/llextdirectory is starting to make sense though... I also wanted to create a${PROJECT_BINARY_DIR}/llextdirectory for all artifacts, but I'm not super confident about how to ensure CMake will create said directory, so the report is in artifacts root for now (like SLID listings).There's also a bit more clean-up I found along the way (namely: a single
llext_discarded_strtabcould replace the two sectionsllext_discarded_exports_strtab+llext_exports_strtab, andread_strcould possibly be shared between scripts), but that can always come later.Example output on
west build samples/subsys/llext/modules:Example build log + output when a group Kconfig is missing: