kernel: Introduce a way to specify minimum system heap size #65908
Conversation
This file contains 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
jhedberg
requested review from
carlocaione,
soburi,
carlescufi,
mmahadevan108,
dleach02,
ifyall and
npal-cy
as code owners
jhedberg
requested review from
najumon1980,
kartben,
tbursztyka and
finikorg
and removed request for
carlocaione,
soburi,
carlescufi,
mmahadevan108,
dleach02,
ifyall and
npal-cy
zephyrbot
requested review from
anangl,
carlocaione,
edersondisouza,
fkokosinski,
katsuster,
kgugala,
laurenmurphyx64,
LucasTambor,
marekmatej,
mgielda,
sylvioalves and
tgorochowik
added 9 commits
December 18, 2023 21:19
Kconfig options with a HEAP_MEM_POOL_ADD_SIZE_ prefix should be used to set the minimum required system heap size. This helps prevent applications from creating a non-working image by trying to set a too small value. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Kconfig options with a HEAP_MEM_POOL_ADD_SIZE_ prefix should be used to set the minimum required system heap size. This helps prevent applications from creating a non-working image by trying to set a too small value. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Kconfig options with a HEAP_MEM_POOL_ADD_SIZE_ prefix should be used to set the minimum required system heap size. This helps prevent applications from creating a non-working image by trying to set a too small value. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Kconfig options with a HEAP_MEM_POOL_ADD_SIZE_ prefix should be used to set the minimum required system heap size. This helps prevent applications from creating a non-working image by trying to set a too small value. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Kconfig options with a HEAP_MEM_POOL_ADD_SIZE_ prefix should be used to set the minimum required system heap size. This helps prevent applications from creating a non-working image by trying to set a too small value. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Kconfig options with a HEAP_MEM_POOL_ADD_SIZE_ prefix should be used to set the minimum required system heap size. This helps prevent applications from creating a non-working image by trying to set a too small value. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Kconfig options with a HEAP_MEM_POOL_ADD_SIZE_ prefix should be used to set the minimum required system heap size. This helps prevent applications from creating a non-working image by trying to set a too small value. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Use the new HEAP_MEM_POOL_ADD_SIZE_ prefix to construct a minimum requirement for posix message queue usage. This way we can remove the "special case" default values from the HEAP_MEM_POOL_SIZE Kconfig definition. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
This is needed so that module uses K_HEAP_MEM_POOL_SIZE for determining the availablility of the k_malloc family of functions. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
jhedberg
force-pushed
the
heap_min_size
branch
from
141984c to
6949ab0
Compare
|
Rebased, and updated the libmetal reference to point at zephyrproject-rtos/libmetal#25 instead of zephyrproject-rtos/libmetal#23 |
added 2 commits
December 18, 2023 22:28
This is needed so that module uses K_HEAP_MEM_POOL_SIZE for determining the availablility of the k_malloc family of functions. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Add a note about the new K_MEM_POOL_HEAP_SIZE define and the mechanism for specifying custom system heap size requirements. Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
jhedberg
force-pushed
the
heap_min_size
branch
from
6949ab0 to
087c005
Compare
|
..and now rebased again with the final libmetal SHA after zephyrproject-rtos/libmetal#25 was merged Now all CI checks should (hopefully) be green. @nordicjm thanks for the thorough analysis of places that most likely still require updating. I think those updates can be done gradually after this PR has been merged. The idea with having similar template support as we have for logging kconfig symbols sounds like a nice follow-up improvement as well. |
nordicjm
approved these changes
Dec 19, 2023
tbursztyka
approved these changes
Dec 19, 2023
tejlmand
approved these changes
Dec 19, 2023
There was a problem hiding this comment.
Approved.
Minor nit observed. Kconfig.defconfigs should generally not define settings, only adjust defaults of settings defined elsewhere.
But as this PR is changing HEAP_MEM_POOL_SIZE -> HEAP_MEM_POOL_ADD_SIZE, then moving this to the board's Kconfig can done as followup.
finikorg
approved these changes
Dec 19, 2023
carlescufi
approved these changes
Dec 19, 2023
sylvioalves
approved these changes
Dec 19, 2023
jukkar
approved these changes
Dec 19, 2023
andyross
approved these changes
Dec 20, 2023
|
I know that it's merged already but it would be better if |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There are several subsystems and boards which require a relatively large system heap (used by k_malloc()) to function properly. This became even more notable with the recent introduction of the ACPICA library, which causes ACPI-using boards to require a system heap of up to several megabytes in size.
Until now, subsystems and boards have tried to solve this by having Kconfig overlays which modify the default value of HEAP_MEM_POOL_SIZE. This works ok, except when applications start explicitly setting values in their prj.conf files:
The vast majority of values set by current sample or test applications is much too small for subsystems like ACPI, which results in the application not being able to run on such boards.
To solve this situation, we introduce support for subsystems to specify their own custom system heap size requirement. Subsystems do this by defining Kconfig options with the prefix HEAP_MEM_POOL_ADD_SIZE_. The final value of the system heap is the sum of the custom minimum requirements, or the value existing HEAP_MEM_POOL_SIZE option, whichever is greater.
We also introduce a new HEAP_MEM_POOL_IGNORE_MIN Kconfig option which applications can use to force a lower value than what subsystems have specficied, however this behavior is disabled by default.
Whenever the minimum is greater than the requested value a CMake warning will be issued in the build output.
This patch ends up modifying several places outside of kernel code, since the presence of the system heap is no longer detected using a non-zero CONFIG_HEAP_MEM_POOL_SIZE value, rather it's now detected using a new K_HEAP_MEM_POOL_SIZE value that's evaluated at build time.
Fixes #65722