Skip to content

Commit

Permalink
memalign: respect malloc_alwaysinternal_limit
Browse files Browse the repository at this point in the history
This changes `memalign` (and `posix_memalign`) so that it uses an
allocation method with the same selection criteria (checking
`malloc_alwaysinternal_limit` and picking one of:

 - always MALLOC_CAP_INTERNAL
 - MALLOC_CAP_INTERNAL first with fallback
 - MALLOC_CAP_SPIRAM first with fallback

`malloc_alwaysinternal_limit` is in turn set by the options
`CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL` and
`CONFIG_SPRIAM_USE_CAPS_ALLOC`.

This notably affects folks using esp-rs to build rust code for the
esp-idf, as all allocations from rust use `memalign`.
  • Loading branch information
codysch committed Oct 9, 2023
1 parent 272b409 commit f3af259
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 27 deletions.
98 changes: 74 additions & 24 deletions components/heap/heap_caps.c
Original file line number Diff line number Diff line change
Expand Up @@ -655,31 +655,10 @@ size_t heap_caps_get_allocated_size( void *ptr )
return size;
}

HEAP_IRAM_ATTR void *heap_caps_aligned_alloc(size_t alignment, size_t size, uint32_t caps)
static HEAP_IRAM_ATTR void *heap_caps_aligned_alloc_base(size_t alignment, size_t size, uint32_t caps)
{
void *ret = NULL;

if(!alignment) {
return NULL;
}

//Alignment must be a power of two:
if((alignment & (alignment - 1)) != 0) {
return NULL;
}

if (size == 0) {
return NULL;
}

if (size > HEAP_SIZE_MAX) {
// Avoids int overflow when adding small numbers to size, or
// calculating 'end' from start+size, by limiting 'size' to the possible range
heap_caps_alloc_failed(size, caps, __func__);

return NULL;
}

for (int prio = 0; prio < SOC_MEMORY_TYPE_NO_PRIOS; prio++) {
//Iterate over heaps and check capabilities at this priority
heap_t *heap;
Expand All @@ -702,12 +681,83 @@ HEAP_IRAM_ATTR void *heap_caps_aligned_alloc(size_t alignment, size_t size, uint
}
}

heap_caps_alloc_failed(size, caps, __func__);

//Nothing usable found.
return NULL;
}

static HEAP_IRAM_ATTR int heap_caps_aligned_check_args(size_t alignment, size_t size, const char *funcname) {
if (!alignment) {
return -1;
}

// Alignment must be a power of two:
if ((alignment & (alignment - 1)) != 0) {
return -1;
}

if (size == 0) {
return -1;
}

if (size > HEAP_SIZE_MAX) {
// Avoids int overflow when adding small numbers to size, or
// calculating 'end' from start+size, by limiting 'size' to the possible range
heap_caps_alloc_failed(size, MALLOC_CAP_DEFAULT, funcname);

return -1;
}

return 0;
}

HEAP_IRAM_ATTR void *heap_caps_aligned_alloc_default(size_t alignment, size_t size)
{
void *ret = NULL;

if (malloc_alwaysinternal_limit == MALLOC_DISABLE_EXTERNAL_ALLOCS) {
return heap_caps_aligned_alloc(alignment, size, MALLOC_CAP_DEFAULT | MALLOC_CAP_INTERNAL);
}

if (heap_caps_aligned_check_args(alignment, size, __func__) != 0) {
return NULL;
}

if (size <= (size_t)malloc_alwaysinternal_limit) {
ret = heap_caps_aligned_alloc_base(alignment, size, MALLOC_CAP_DEFAULT | MALLOC_CAP_INTERNAL);
} else {
ret = heap_caps_aligned_alloc_base(alignment, size, MALLOC_CAP_DEFAULT | MALLOC_CAP_SPIRAM);
}

if (ret != NULL) {
return ret;
}

ret = heap_caps_aligned_alloc_base(alignment, size, MALLOC_CAP_DEFAULT);

if (ret == NULL) {
heap_caps_alloc_failed(size, MALLOC_CAP_DEFAULT, __func__);
}

return ret;
}

HEAP_IRAM_ATTR void *heap_caps_aligned_alloc(size_t alignment, size_t size, uint32_t caps)
{
void *ret = NULL;

if (heap_caps_aligned_check_args(alignment, size, __func__) != 0) {
return NULL;
}

ret = heap_caps_aligned_alloc_base(alignment, size, caps);

if (ret == NULL) {
heap_caps_alloc_failed(size, caps, __func__);
}

return ret;
}

HEAP_IRAM_ATTR void heap_caps_aligned_free(void *ptr)
{
heap_caps_free(ptr);
Expand Down
1 change: 1 addition & 0 deletions components/heap/heap_private.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ inline static uint32_t get_all_caps(const heap_t *heap)
*/
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);


#ifdef __cplusplus
Expand Down
7 changes: 4 additions & 3 deletions components/newlib/heap.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
Expand All @@ -18,6 +18,7 @@
*/
extern void *heap_caps_malloc_default( size_t size );
extern void *heap_caps_realloc_default( void *ptr, size_t size );
extern void *heap_caps_aligned_alloc_default( size_t alignment, size_t size );

void* malloc(size_t size)
{
Expand Down Expand Up @@ -71,7 +72,7 @@ void* _calloc_r(struct _reent *r, size_t nmemb, size_t size)

void* memalign(size_t alignment, size_t n)
{
return heap_caps_aligned_alloc(alignment, n, MALLOC_CAP_DEFAULT);
return heap_caps_aligned_alloc_default(alignment, n);
}

int posix_memalign(void **out_ptr, size_t alignment, size_t size)
Expand All @@ -81,7 +82,7 @@ int posix_memalign(void **out_ptr, size_t alignment, size_t size)
*out_ptr = NULL;
return 0;
}
void *result = heap_caps_aligned_alloc(alignment, size, MALLOC_CAP_DEFAULT);
void *result = heap_caps_aligned_alloc_default(alignment, size);
if (result != NULL) {
/* Modify output pointer only on success */
*out_ptr = result;
Expand Down

0 comments on commit f3af259

Please sign in to comment.