alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
450618c39d
esp-idf/components/heap/Kconfig

133 lines
5.1 KiB
Plaintext
Raw Normal View History

multi_heap: Add heap poisoning features
2017-05-08 01:25:30 -04:00
menu "Heap memory debugging"
Correct Kconfigs according to the coding style
2019-01-25 11:10:53 -05:00
choice HEAP_CORRUPTION_DETECTION
prompt "Heap corruption detection"
default HEAP_POISONING_DISABLED
help
Enable heap poisoning features to detect heap corruption caused by out-of-bounds access to heap memory.
See the "Heap Memory Debugging" page of the IDF documentation
for a description of each level of heap corruption detection.
config HEAP_POISONING_DISABLED
bool "Basic (no poisoning)"
config HEAP_POISONING_LIGHT
bool "Light impact"
config HEAP_POISONING_COMPREHENSIVE
bool "Comprehensive"
endchoice
heap: Separate standalone and common part of tracing module
2018-12-12 12:29:47 -05:00
choice HEAP_TRACING_DEST
bool "Heap tracing"
default HEAP_TRACING_OFF
Correct Kconfigs according to the coding style
2019-01-25 11:10:53 -05:00
help
Enables the heap tracing API defined in esp_heap_trace.h.
This function causes a moderate increase in IRAM code side and a minor increase in heap function
heap: Separate standalone and common part of tracing module
2018-12-12 12:29:47 -05:00
(malloc/free/realloc) CPU overhead, even when the tracing feature is not used.
So it's best to keep it disabled unless tracing is being used.
config HEAP_TRACING_OFF
bool "Disabled"
config HEAP_TRACING_STANDALONE
bool "Standalone"
select HEAP_TRACING
config HEAP_TRACING_TOHOST
bool "Host-based"
select HEAP_TRACING
endchoice
config HEAP_TRACING
bool
default F
help
Enables/disables heap tracing API.
Correct Kconfigs according to the coding style
2019-01-25 11:10:53 -05:00
config HEAP_TRACING_STACK_DEPTH
int "Heap tracing stack depth"
heap: use hal specific API to get cpu cycles count This fixes compilation issue of heap tracing feature for RISC-V architecture.
2021-06-11 03:38:11 -04:00
range 0 0 if IDF_TARGET_ARCH_RISCV # Disabled for RISC-V due to `__builtin_return_address` limitation
default 0 if IDF_TARGET_ARCH_RISCV
Correct Kconfigs according to the coding style
2019-01-25 11:10:53 -05:00
range 0 10
default 2
depends on HEAP_TRACING
help
Number of stack frames to save when tracing heap operation callers.
More stack frames uses more memory in the heap trace buffer (and slows down allocation), but
can provide useful information.
heap: Wrap the function hook feature under a configuration also update heap_debug.rst and mem_alloc.rst to provide information about the feature
2023-03-08 04:48:17 -05:00
config HEAP_USE_HOOKS
bool "Use allocation and free hooks"
help
Enable the user to implement function hooks triggered for each successful allocation and free.
Correct Kconfigs according to the coding style
2019-01-25 11:10:53 -05:00
config HEAP_TASK_TRACKING
bool "Enable heap task tracking"
depends on !HEAP_POISONING_DISABLED
help
Enables tracking the task responsible for each heap allocation.
This function depends on heap poisoning being enabled and adds four more bytes of overhead for each block
allocated.
heap: Add task tracking option for heap usage monitoring Add back a feature that was available in the old heap implementation in release/v2.1 and earlier: keep track of which task allocates each block from the heap. The task handle is conditionally added as another word in the heap poisoning header under this configuration option CONFIG_HEAP_TASK_TRACKING. To allow custom monitoring and debugging code to be added, add helper functions in multi_heap.c and multi_heap_poisoning.c to provide access to information in the block headers. Add esp_heap_debug_dump_totals() to monitor heap usage esp_heap_debug_dump_totals() dumps into a user-provided data structure a summary of the amound of heap memory in region type that is used by each task. Optionally it will also dump into another data structure the metadata about each allocated block for a given list of tasks or for all tasks (limited by available space). Address change requests on PR #1498 This set of changes fixes the files in e3b702c to just add the CONFIG_HEAP_TASK_TRACKING option without adding the new function heap_caps_get_per_task_info() in case that is the only portion of the PR that will be accepted. Part of the change is to remove the new .c and .h files containing that function and to remove the line to compile it from components/heap/component.mk since it should not have been included in e3b702c. One or more additional commits to add the new function will follow. The other changes here: - uint32_t get_all_caps() moves to heap_private.h - replace "void* foo" with "void *foo" - add braces around single-line "if" blocks - replace tab characters with spaces Address change requests on PR #1498, part 2 This set of changes fixes the files in cdf32aa to add the new function heap_caps_get_per_task_info() with its new name and to add the line to compile it in components/heap/component.mk. This does not address all the suggested changes because there are some needing further discussion. This commit does not include the suggested change to move the declaration of the new function into esp_heap_caps.h because the new function references TaskHandle_t so esp_heap_caps.h would have to include freertos/FreeRTOS.h and freertos/task.h, but FreeRTOS.h includes esp_heap_caps.h through two other header files which results in compilation errors because not all of FreeRTOS.h has been read yet. Change heap_caps_get_per_task_info() to take struct of params In addition to moving the large number of function parameters into a struct as the single parameter, the following changes were made: - Clear out the totals for any prepopulated tasks so the app code doesn't have to do it. - Rather than partitioning the per-task totals into a predetermined set of heap capabilities, take a list of <caps,mask> pairs to compare the caps to the heap capabilities as masked. This lets the caller configure the desired partitioning, or none. - Allow the totals array pointer or the blocks array pointer to be NULL to indicate not to collect that part of the information. - In addition to returning the total space allocated by each task, return the number of blocks allocated by each task. - Don't need to return the heap capabilities as part of the details for each block since the heap region (and therefore its capabilities) can be determined from the block address. - Renamed heap_task_info.h to esp_heap_task_info.h to fit the naming convention, and renamed the structs for totals and block details to better fit the revised function name. - Provide full Doxygen commenting for the function and parameter structs. Add copyright header to new files Merges https://github.com/espressif/esp-idf/pull/1498
2018-01-10 04:14:47 -05:00
heap: Add trace hash map config - and place all added functions and vairables related to the hashmap in RAM when the config is enabled only. - add number of hash map entry as a Kconfig value and remove the hash map init function. This prevents the user from allocating the hash map in flash and pass the pointer to the init function (as the heap trace manipulate the hash map from functions placed in IRAM). - add max linear value to the KConfig to make it configurable by the users. - protect access to static variable "tracing" - remove unecessary field in heap_trace_hashmap_entry_t
2023-03-01 06:42:14 -05:00
config HEAP_TRACE_HASH_MAP
bool "Use hash map mechanism to access heap trace records"
depends on HEAP_TRACING_STANDALONE
default n
help
Enable this flag to use a hash map to increase performance in handling
heap trace records.
[Heap Trace Standalone] do not allocate memory until init is called
2023-05-26 01:05:07 -04:00
Heap trace standalone supports storing records as a list, or a list + hash map.
Using only a list takes less memory, but calls to 'free' will get slower as the
docs(heap): fixed typo in heap trace docs
2023-07-06 22:49:15 -04:00
list grows. This is particularly affected when using HEAP_TRACE_ALL mode.
[Heap Trace Standalone] do not allocate memory until init is called
2023-05-26 01:05:07 -04:00
By using a list + hash map, calls to 'free' remain fast, at the cost of
additional memory to store the hash map.
heap: Add trace hash map config - and place all added functions and vairables related to the hashmap in RAM when the config is enabled only. - add number of hash map entry as a Kconfig value and remove the hash map init function. This prevents the user from allocating the hash map in flash and pass the pointer to the init function (as the heap trace manipulate the hash map from functions placed in IRAM). - add max linear value to the KConfig to make it configurable by the users. - protect access to static variable "tracing" - remove unecessary field in heap_trace_hashmap_entry_t
2023-03-01 06:42:14 -05:00
heap: Add trace configuration to allow hash map placement in external RAM bss section when possible - Remove the size limit for the hash_map array from the CONFIG_HEAP_TRACE_HASH_MAP_SIZE - Add test case for heap tracing using hashmap - Update heap_debug.rst to document the newly added configurations in the heap component Closes https://github.com/espressif/esp-idf/issues/11172
2023-04-12 06:17:00 -04:00
config HEAP_TRACE_HASH_MAP_IN_EXT_RAM
[Heap Trace Standalone] do not allocate memory until init is called
2023-05-26 01:05:07 -04:00
bool "Place hash map in external RAM"
depends on HEAP_TRACE_HASH_MAP
heap: Add trace configuration to allow hash map placement in external RAM bss section when possible - Remove the size limit for the hash_map array from the CONFIG_HEAP_TRACE_HASH_MAP_SIZE - Add test case for heap tracing using hashmap - Update heap_debug.rst to document the newly added configurations in the heap component Closes https://github.com/espressif/esp-idf/issues/11172
2023-04-12 06:17:00 -04:00
default n
help
[Heap Trace Standalone] do not allocate memory until init is called
2023-05-26 01:05:07 -04:00
When enabled this configuration forces the hash map to be placed in external RAM.
heap: Add trace configuration to allow hash map placement in external RAM bss section when possible - Remove the size limit for the hash_map array from the CONFIG_HEAP_TRACE_HASH_MAP_SIZE - Add test case for heap tracing using hashmap - Update heap_debug.rst to document the newly added configurations in the heap component Closes https://github.com/espressif/esp-idf/issues/11172
2023-04-12 06:17:00 -04:00
heap: Add trace hash map config - and place all added functions and vairables related to the hashmap in RAM when the config is enabled only. - add number of hash map entry as a Kconfig value and remove the hash map init function. This prevents the user from allocating the hash map in flash and pass the pointer to the init function (as the heap trace manipulate the hash map from functions placed in IRAM). - add max linear value to the KConfig to make it configurable by the users. - protect access to static variable "tracing" - remove unecessary field in heap_trace_hashmap_entry_t
2023-03-01 06:42:14 -05:00
config HEAP_TRACE_HASH_MAP_SIZE
int "The number of entries in the hash map"
depends on HEAP_TRACE_HASH_MAP
[Heap Trace Standalone] do not allocate memory until init is called
2023-05-26 01:05:07 -04:00
default 512
heap: Add trace hash map config - and place all added functions and vairables related to the hashmap in RAM when the config is enabled only. - add number of hash map entry as a Kconfig value and remove the hash map init function. This prevents the user from allocating the hash map in flash and pass the pointer to the init function (as the heap trace manipulate the hash map from functions placed in IRAM). - add max linear value to the KConfig to make it configurable by the users. - protect access to static variable "tracing" - remove unecessary field in heap_trace_hashmap_entry_t
2023-03-01 06:42:14 -05:00
help
[Heap Trace Standalone] do not allocate memory until init is called
2023-05-26 01:05:07 -04:00
Defines the number of entries in the heap trace hashmap. Each entry takes 8 bytes.
The bigger this number is, the better the performance. Recommended range: 200 - 2000.
heap: Add trace hash map config - and place all added functions and vairables related to the hashmap in RAM when the config is enabled only. - add number of hash map entry as a Kconfig value and remove the hash map init function. This prevents the user from allocating the hash map in flash and pass the pointer to the init function (as the heap trace manipulate the hash map from functions placed in IRAM). - add max linear value to the KConfig to make it configurable by the users. - protect access to static variable "tracing" - remove unecessary field in heap_trace_hashmap_entry_t
2023-03-01 06:42:14 -05:00
heap: added alloc failed hook and configuration options heap/test: added alloc failed hook tests docs: added alloc failed hook documentation heap: add function to register allocation failed hook docs: allocation failed hook docs improvements
2020-04-27 16:09:15 -04:00
config HEAP_ABORT_WHEN_ALLOCATION_FAILS
bool "Abort if memory allocation fails"
default n
help
When enabled, if a memory allocation operation fails it will cause a system abort.
heap: use ROM implementation for heap tlsf on esp32c2
2022-05-06 07:20:05 -04:00
config HEAP_TLSF_USE_ROM_IMPL
bool "Use ROM implementation of heap tlsf library"
depends on ESP_ROM_HAS_HEAP_TLSF
heap_tlsf: use tlsf IMPL in ESP32C2 ROM
2021-03-19 05:29:42 -04:00
default y
help
Enable this flag to use heap functions from ROM instead of ESP-IDF.
If keeping this as "n" in your project, you will have less free IRAM.
If making this as "y" in your project, you will increase free IRAM,
but you will lose the possibility to debug this module, and some new
features will be added and bugs will be fixed in the IDF source
but cannot be synced to ROM.
heap: Add a configuration that places all the heap component and related functionalities in flash when enabled Add test configuration to run all tests with heap component in the flash. Add reference to this new configuration in performance section of the documentation.
2023-04-03 09:16:55 -04:00
config HEAP_PLACE_FUNCTION_INTO_FLASH
bool "Force the entire heap component to be placed in flash memory"
depends on !HEAP_TLSF_USE_ROM_IMPL
default n
help
Enable this flag to save up RAM space by placing the heap component in the flash memory
Note that it is only safe to enable this configuration if no functions from esp_heap_caps.h
or esp_heap_trace.h are called from ISR.
multi_heap: Add heap poisoning features
2017-05-08 01:25:30 -04:00
endmenu
Reference in New Issue Copy Permalink