mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-08 12:10:59 +00:00

This feature keeps track of the per task peak memory usage. - Update the heap_task_tracking example to make use of the new feature Cleanup the implementation: - multi_heap_get_free_size() is never used, remove it. - Minor update in heap_caps_update_per_task_info_xx() funcitons. - Update settting on block owner in heap_caps.c to work with the get peak usage feature. - Update heap_caps_update_per_task_info_free() to detect when it is called to delete the memory allocated for a task TCB. Mark the corresponding task in the statistic list as deleted. - Add a Kconfig option dependant on HEAP_TASK_TRACKING being enabled that force the deletion of the statistics related to deleted task when set to true. - In task tracking feature, add a current and peak memory usage to the heap_stat_t structure to keep track of the current and peak memory usage of the given task across all heaps. - Fix missing block owner when allocating memory for heaps_array in heap_caps_init. - Keep the original implementation of the task tracking for backward compatibility reasons.
101 lines
3.0 KiB
C
101 lines
3.0 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stdlib.h>
|
|
#include <stdint.h>
|
|
#include <soc/soc_memory_layout.h>
|
|
#include "multi_heap.h"
|
|
#include "multi_heap_platform.h"
|
|
#include "sys/queue.h"
|
|
#include "esp_attr.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Some common heap registration data structures used
|
|
for heap_caps_init.c to share heap information with heap_caps.c
|
|
*/
|
|
|
|
#define HEAP_SIZE_MAX (SOC_MAX_CONTIGUOUS_RAM_SIZE)
|
|
|
|
/* Type for describing each registered heap */
|
|
typedef struct heap_t_ {
|
|
#if CONFIG_HEAP_TASK_TRACKING
|
|
const char *name;
|
|
#endif // CONFIG_HEAP_TASK_TRACKING
|
|
uint32_t caps[SOC_MEMORY_TYPE_NO_PRIOS]; ///< Capabilities for the type of memory in this heap (as a prioritised set). Copied from soc_memory_types so it's in RAM not flash.
|
|
intptr_t start;
|
|
intptr_t end;
|
|
multi_heap_lock_t heap_mux;
|
|
multi_heap_handle_t heap;
|
|
SLIST_ENTRY(heap_t_) next;
|
|
} heap_t;
|
|
|
|
/* All registered heaps.
|
|
|
|
Forms a single linked list, even though most entries are contiguous.
|
|
This means at the expense of 4 bytes per heap, new heaps can be
|
|
added at runtime in a fast & thread-safe way.
|
|
*/
|
|
extern SLIST_HEAD(registered_heap_ll, heap_t_) registered_heaps;
|
|
|
|
bool heap_caps_match(const heap_t *heap, uint32_t caps);
|
|
|
|
FORCE_INLINE_ATTR uint32_t get_ored_caps(const uint32_t caps[SOC_MEMORY_TYPE_NO_PRIOS])
|
|
{
|
|
uint32_t all_caps = 0;
|
|
for (int prio = 0; prio < SOC_MEMORY_TYPE_NO_PRIOS; prio++) {
|
|
all_caps |= caps[prio];
|
|
}
|
|
return all_caps;
|
|
}
|
|
|
|
/* return all possible capabilities (across all priorities) for a given heap */
|
|
FORCE_INLINE_ATTR uint32_t get_all_caps(const heap_t *heap)
|
|
{
|
|
if (heap->heap == NULL) {
|
|
return 0;
|
|
}
|
|
return get_ored_caps(heap->caps);
|
|
}
|
|
|
|
/* Find the heap which belongs to ptr, or return NULL if it's
|
|
not in any heap.
|
|
|
|
(This confirms if ptr is inside the heap's region, doesn't confirm if 'ptr'
|
|
is an allocated block or is some other random address inside the heap.)
|
|
*/
|
|
FORCE_INLINE_ATTR heap_t *find_containing_heap(void *ptr )
|
|
{
|
|
intptr_t p = (intptr_t)ptr;
|
|
heap_t *heap;
|
|
SLIST_FOREACH(heap, ®istered_heaps, next) {
|
|
if (heap->heap != NULL && p >= heap->start && p < heap->end) {
|
|
return heap;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
/*
|
|
Because we don't want to add _another_ known allocation method to the stack of functions to trace wrt memory tracing,
|
|
these are declared private. The newlib malloc()/realloc() implementation also calls these, so they are declared
|
|
separately in newlib/syscalls.c.
|
|
*/
|
|
void *heap_caps_realloc_default(void *p, size_t size);
|
|
void *heap_caps_malloc_default(size_t size);
|
|
void *heap_caps_aligned_alloc_default(size_t alignment, size_t size);
|
|
void *heap_caps_realloc_base(void *ptr, size_t size, uint32_t caps);
|
|
void *heap_caps_calloc_base(size_t n, size_t size, uint32_t caps);
|
|
void *heap_caps_malloc_base(size_t size, uint32_t caps);
|
|
void *heap_caps_aligned_alloc_base(size_t alignment, size_t size, uint32_t caps);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|