feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

heap: Use linked list in hashmap table to reduce collision, RAM usage and speed up the code

Browse Source
This commit is contained in:
Guillaume Souchere
2023-03-30 12:37:51 +02:00
parent bdfc348ab3
commit 14fa303bbc
3 changed files with 60 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
components/heap/Kconfig
View File

@@ -87,23 +87,12 @@ menu "Heap memory debugging"
config HEAP_TRACE_HASH_MAP_SIZE config HEAP_TRACE_HASH_MAP_SIZE
int "The number of entries in the hash map" int "The number of entries in the hash map"
depends on HEAP_TRACE_HASH_MAP depends on HEAP_TRACE_HASH_MAP
range 10 10000 range 1 10000
default 100
help
Defines the number of entries in the heap trace hashmap. The bigger this number is,
the bigger the hash map will be in the memory and the lower the miss probability will
be when handling heap trace records.
config HEAP_TRACE_HASH_MAP_MAX_LINEAR
int "The number of iterations when searching for an entry in the hash map."
depends on HEAP_TRACE_HASH_MAP
range 1 HEAP_TRACE_HASH_MAP_SIZE
default 10 default 10
help help
Defines the number of iterations when searching for an entry in the hashmap. The closer Defines the number of entries in the heap trace hashmap. The bigger this number is,
this number is from the number of entries in the hashmap, the lower the miss chances are the bigger the hash map will be in the memory. In case the tracing mode is set to
but the slower the hashmap mechanism is. The lower this number is, the higher the miss HEAP_TRACE_ALL, the bigger the hashmap is, the better the performances are.
probability is but the faster the hashmap mechanism is.
config HEAP_ABORT_WHEN_ALLOCATION_FAILS config HEAP_ABORT_WHEN_ALLOCATION_FAILS
bool "Abort if memory allocation fails" bool "Abort if memory allocation fails"

125
components/heap/heap_trace_standalone.c
View File

@@ -81,61 +81,47 @@ static size_t r_get_idx;
#if CONFIG_HEAP_TRACE_HASH_MAP #if CONFIG_HEAP_TRACE_HASH_MAP
typedef struct heap_trace_hashmap_entry_t { /* Define struct: linked list of records used in hash map */
heap_trace_record_t* record; // associated record TAILQ_HEAD(heap_trace_hash_list_struct_t, heap_trace_record_t);
} heap_trace_hashmap_entry_t; typedef struct heap_trace_hash_list_struct_t heap_trace_hash_list_t;
static heap_trace_hashmap_entry_t hash_map[(size_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE]; // Buffer used for hashmap entries static heap_trace_hash_list_t hash_map[(size_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE]; // Buffer used for hashmap entries
static size_t total_hashmap_hits; static size_t total_hashmap_hits;
static size_t total_hashmap_miss; static size_t total_hashmap_miss;
static size_t hash_idx(void* p) static size_t hash_idx(void* p)
{ {
static const uint32_t fnv_prime = 16777619UL; // expression 224 + 28 + 0x93 (32 bits size) static const uint32_t fnv_prime = 16777619UL; // expression 2^24 + 2^8 + 0x93 (32 bits size)
return ((uint32_t)p * fnv_prime) % (uint32_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE; // since all the addresses are 4 bytes aligned, computing address * fnv_prime always gives
// a modulo 4 number. The bit shift goal is to distribute more evenly the hashes in the
// given range [0 , CONFIG_HEAP_TRACE_HASH_MAP_SIZE - 1].
return ((((uint32_t)p >> 3) +
((uint32_t)p >> 5) +
((uint32_t)p >> 7)) * fnv_prime) % (uint32_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE;
} }
static void map_add(const heap_trace_record_t *r_add) static void map_add(heap_trace_record_t *r_add)
{ {
size_t idx = hash_idx(r_add->address); size_t idx = hash_idx(r_add->address);
TAILQ_INSERT_TAIL(&hash_map[idx], r_add, tailq_hashmap);
// linear search: find empty location
for(size_t i = 0; i < CONFIG_HEAP_TRACE_HASH_MAP_MAX_LINEAR; i++) {
size_t n = (i + idx) % (size_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE;
if (hash_map[n].record == NULL) {
hash_map[n].record = (heap_trace_record_t*) r_add;
break;
}
}
} }
static void map_remove(void *p) static void map_remove(heap_trace_record_t *r_remove)
{ {
size_t idx = hash_idx(p); size_t idx = hash_idx(r_remove->address);
TAILQ_REMOVE(&hash_map[idx], r_remove, tailq_hashmap);
// linear search: find matching address
for(size_t i = 0; i < CONFIG_HEAP_TRACE_HASH_MAP_MAX_LINEAR; i++) {
size_t n = (i + idx) % (size_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE;
if (hash_map[n].record != NULL && hash_map[n].record->address == p) {
hash_map[n].record = NULL;
break;
}
}
} }
static heap_trace_record_t* map_find(void *p) static heap_trace_record_t* map_find(void *p)
{ {
size_t idx = hash_idx(p); size_t idx = hash_idx(p);
heap_trace_record_t *r_cur = NULL;
// linear search: find matching address TAILQ_FOREACH(r_cur, &hash_map[idx], tailq_hashmap) {
for(size_t i = 0; i < CONFIG_HEAP_TRACE_HASH_MAP_MAX_LINEAR; i++) { if (r_cur->address == p) {
size_t n = (i + idx) % (size_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE;
if (hash_map[n].record != NULL && hash_map[n].record->address == p) {
total_hashmap_hits++; total_hashmap_hits++;
return hash_map[n].record; return r_cur;
} }
} }
total_hashmap_miss++; total_hashmap_miss++;
return NULL; return NULL;
} }
@@ -181,7 +167,10 @@ esp_err_t heap_trace_start(heap_trace_mode_t mode_param)
memset(records.buffer, 0, sizeof(heap_trace_record_t) * records.capacity); memset(records.buffer, 0, sizeof(heap_trace_record_t) * records.capacity);
#if CONFIG_HEAP_TRACE_HASH_MAP #if CONFIG_HEAP_TRACE_HASH_MAP
memset(hash_map, 0, sizeof(hash_map)); for (size_t i = 0; i < (size_t)CONFIG_HEAP_TRACE_HASH_MAP_SIZE; i++) {
TAILQ_INIT(&hash_map[i]);
}
total_hashmap_hits = 0; total_hashmap_hits = 0;
total_hashmap_miss = 0; total_hashmap_miss = 0;
#endif // CONFIG_HEAP_TRACE_HASH_MAP #endif // CONFIG_HEAP_TRACE_HASH_MAP
@@ -239,7 +228,7 @@ esp_err_t heap_trace_get(size_t index, heap_trace_record_t *r_out)
// Perf: speed up sequential access // Perf: speed up sequential access
if (r_get && r_get_idx == index - 1) { if (r_get && r_get_idx == index - 1) {
r_get = TAILQ_NEXT(r_get, tailq); r_get = TAILQ_NEXT(r_get, tailq_list);
r_get_idx = index; r_get_idx = index;
} else { } else {
@@ -254,7 +243,7 @@ esp_err_t heap_trace_get(size_t index, heap_trace_record_t *r_out)
break; break;
} }
r_get = TAILQ_NEXT(r_get, tailq); r_get = TAILQ_NEXT(r_get, tailq_list);
r_get_idx = i + 1; r_get_idx = i + 1;
} }
} }
@@ -359,7 +348,7 @@ static void heap_trace_dump_base(bool internal_ram, bool psram)
} }
} }
r_cur = TAILQ_NEXT(r_cur, tailq); r_cur = TAILQ_NEXT(r_cur, tailq_list);
} }
esp_rom_printf("====== Heap Trace Summary ======\n"); esp_rom_printf("====== Heap Trace Summary ======\n");
@@ -405,7 +394,6 @@ static IRAM_ATTR void record_allocation(const heap_trace_record_t *r_allocation)
portENTER_CRITICAL(&trace_mux); portENTER_CRITICAL(&trace_mux);
if (tracing) { if (tracing) {
// If buffer is full, pop off the oldest // If buffer is full, pop off the oldest
// record to make more space // record to make more space
if (records.count == records.capacity) { if (records.count == records.capacity) {
@@ -415,21 +403,9 @@ static IRAM_ATTR void record_allocation(const heap_trace_record_t *r_allocation)
heap_trace_record_t *r_first = TAILQ_FIRST(&records.list); heap_trace_record_t *r_first = TAILQ_FIRST(&records.list);
list_remove(r_first); list_remove(r_first);
#if CONFIG_HEAP_TRACE_HASH_MAP
map_remove(r_first->address);
}
// push onto end of list
heap_trace_record_t *r_dest = list_add(r_allocation);
// add to hashmap
if (r_dest) {
map_add(r_dest);
}
#else
} }
// push onto end of list // push onto end of list
list_add(r_allocation); list_add(r_allocation);
#endif // CONFIG_HEAP_TRACE_HASH_MAP
total_allocations++; total_allocations++;
} }
@@ -446,7 +422,7 @@ static IRAM_ATTR void record_allocation(const heap_trace_record_t *r_allocation)
*/ */
static IRAM_ATTR void record_free(void *p, void **callers) static IRAM_ATTR void record_free(void *p, void **callers)
{ {
if (!tracing || p == NULL) { if (!tracing || p == NULL) {
return; return;
} }
@@ -463,19 +439,7 @@ static IRAM_ATTR void record_free(void *p, void **callers)
total_frees++; total_frees++;
#if CONFIG_HEAP_TRACE_HASH_MAP
// check the hashmap
heap_trace_record_t *r_found = map_find(p);
// list search
if(!r_found) {
r_found = list_find_address_reverse(p);
}
#else
heap_trace_record_t *r_found = list_find_address_reverse(p); heap_trace_record_t *r_found = list_find_address_reverse(p);
#endif // CONFIG_HEAP_TRACE_HASH_MAP
// search backwards for the allocation record matching this fre
if (r_found) { if (r_found) {
if (mode == HEAP_TRACE_ALL) { if (mode == HEAP_TRACE_ALL) {
@@ -483,13 +447,9 @@ static IRAM_ATTR void record_free(void *p, void **callers)
memcpy(r_found->freed_by, callers, sizeof(void *) * STACK_DEPTH); memcpy(r_found->freed_by, callers, sizeof(void *) * STACK_DEPTH);
} else { // HEAP_TRACE_LEAKS } else { // HEAP_TRACE_LEAKS
// Leak trace mode, once an allocation is freed // Leak trace mode, once an allocation is freed
// we remove it from the list & hashmap // we remove it from the list & hashmap
list_remove(r_found); list_remove(r_found);
#if CONFIG_HEAP_TRACE_HASH_MAP
map_remove(p);
#endif // CONFIG_HEAP_TRACE_HASH_MAP
} }
} }
} }
@@ -507,7 +467,7 @@ static void list_setup(void)
heap_trace_record_t *r_cur = &records.buffer[i]; heap_trace_record_t *r_cur = &records.buffer[i];
TAILQ_INSERT_TAIL(&records.unused, r_cur, tailq); TAILQ_INSERT_TAIL(&records.unused, r_cur, tailq_list);
} }
} }
@@ -517,15 +477,19 @@ static IRAM_ATTR void list_remove(heap_trace_record_t *r_remove)
{ {
assert(records.count > 0); assert(records.count > 0);
#if CONFIG_HEAP_TRACE_HASH_MAP
map_remove(r_remove);
#endif
// remove from records.list // remove from records.list
TAILQ_REMOVE(&records.list, r_remove, tailq); TAILQ_REMOVE(&records.list, r_remove, tailq_list);
// set as unused // set as unused
r_remove->address = 0; r_remove->address = 0;
r_remove->size = 0; r_remove->size = 0;
// add to records.unused // add to records.unused
TAILQ_INSERT_HEAD(&records.unused, r_remove, tailq); TAILQ_INSERT_HEAD(&records.unused, r_remove, tailq_list);
// decrement // decrement
records.count--; records.count--;
@@ -546,7 +510,7 @@ static IRAM_ATTR heap_trace_record_t* list_pop_unused(void)
assert(r_unused->size == 0); assert(r_unused->size == 0);
// remove from records.unused // remove from records.unused
TAILQ_REMOVE(&records.unused, r_unused, tailq); TAILQ_REMOVE(&records.unused, r_unused, tailq_list);
return r_unused; return r_unused;
} }
@@ -579,7 +543,7 @@ static IRAM_ATTR heap_trace_record_t* list_add(const heap_trace_record_t *r_appe
record_deep_copy(r_dest, r_append); record_deep_copy(r_dest, r_append);
// append to records.list // append to records.list
TAILQ_INSERT_TAIL(&records.list, r_dest, tailq); TAILQ_INSERT_TAIL(&records.list, r_dest, tailq_list);
// increment // increment
records.count++; records.count++;
@@ -589,6 +553,10 @@ static IRAM_ATTR heap_trace_record_t* list_add(const heap_trace_record_t *r_appe
records.high_water_mark = records.count; records.high_water_mark = records.count;
} }
#if CONFIG_HEAP_TRACE_HASH_MAP
map_add(r_dest);
#endif
return r_dest; return r_dest;
} else { } else {
@@ -602,10 +570,19 @@ static IRAM_ATTR heap_trace_record_t* list_find_address_reverse(void *p)
{ {
heap_trace_record_t *r_found = NULL; heap_trace_record_t *r_found = NULL;
#if CONFIG_HEAP_TRACE_HASH_MAP
// check the hashmap
r_found = map_find(p);
if (r_found != NULL) {
return r_found;
}
#endif
// Perf: We search backwards because new allocations are appended // Perf: We search backwards because new allocations are appended
// to the end of the list and most allocations are short lived. // to the end of the list and most allocations are short lived.
heap_trace_record_t *r_cur = NULL; heap_trace_record_t *r_cur = NULL;
TAILQ_FOREACH_REVERSE(r_cur, &records.list, heap_trace_record_list_struct_t, tailq) { TAILQ_FOREACH(r_cur, &records.list, tailq_list) {
if (r_cur->address == p) { if (r_cur->address == p) {
r_found = r_cur; r_found = r_cur;
break; break;

7
components/heap/include/esp_heap_trace.h
View File

@@ -36,8 +36,11 @@ typedef struct heap_trace_record_t {
size_t size; ///< Size of the allocation size_t size; ///< Size of the allocation
void *alloced_by[CONFIG_HEAP_TRACING_STACK_DEPTH]; ///< Call stack of the caller which allocated the memory. void *alloced_by[CONFIG_HEAP_TRACING_STACK_DEPTH]; ///< Call stack of the caller which allocated the memory.
void *freed_by[CONFIG_HEAP_TRACING_STACK_DEPTH]; ///< Call stack of the caller which freed the memory (all zero if not freed.) void *freed_by[CONFIG_HEAP_TRACING_STACK_DEPTH]; ///< Call stack of the caller which freed the memory (all zero if not freed.)
#ifdef CONFIG_HEAP_TRACING_STANDALONE #if CONFIG_HEAP_TRACING_STANDALONE
TAILQ_ENTRY(heap_trace_record_t) tailq; ///< Linked list: prev & next records TAILQ_ENTRY(heap_trace_record_t) tailq_list; ///< Linked list: prev & next records
#if CONFIG_HEAP_TRACE_HASH_MAP
TAILQ_ENTRY(heap_trace_record_t) tailq_hashmap; ///< Linked list: prev & next in hashmap entry list
#endif // CONFIG_HEAP_TRACE_HASH_MAP
#endif // CONFIG_HEAP_TRACING_STANDALONE #endif // CONFIG_HEAP_TRACING_STANDALONE
} heap_trace_record_t; } heap_trace_record_t;