Skip to content

Commit

Permalink
allow each zone of memory allocated to heap to have different control…
Browse files Browse the repository at this point in the history 
… block

See espressif#7822
  • Loading branch information
@philippe44
philippe44 committed Nov 4, 2021
1 parent 98d34e5 commit beb15f7
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 125 deletions.
129 changes: 79 additions & 50 deletions components/heap/heap_tlsf.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,6 @@ tlsf_static_assert(sizeof(int) * CHAR_BIT == 32);
tlsf_static_assert(sizeof(size_t) * CHAR_BIT >= 32);
tlsf_static_assert(sizeof(size_t) * CHAR_BIT <= 64);

/* SL_INDEX_COUNT must be <= number of bits in sl_bitmap's storage type. */
tlsf_static_assert(sizeof(unsigned int) * CHAR_BIT >= SL_INDEX_COUNT);

/* Ensure we've properly tuned our sizes. */
tlsf_static_assert(ALIGN_SIZE == SMALL_BLOCK_SIZE / SL_INDEX_COUNT);

static inline __attribute__((__always_inline__)) size_t align_up(size_t x, size_t align)
{
tlsf_assert(0 == (align & (align - 1)) && "must align to a power of two");
Expand All @@ -120,15 +114,15 @@ static inline __attribute__((__always_inline__)) void* align_ptr(const void* ptr
** Adjust an allocation size to be aligned to word size, and no smaller
** than internal minimum.
*/
static inline __attribute__((__always_inline__)) size_t adjust_request_size(size_t size, size_t align)
static inline __attribute__((__always_inline__)) size_t adjust_request_size(tlsf_t tlsf, size_t size, size_t align)
{
size_t adjust = 0;
if (size)
{
const size_t aligned = align_up(size, align);

/* aligned sized must not exceed block_size_max or we'll go out of bounds on sl_bitmap */
if (aligned < block_size_max)
if (aligned < tlsf_block_size_max(tlsf))
{
adjust = tlsf_max(aligned, block_size_min);
}
Expand All @@ -141,10 +135,10 @@ static inline __attribute__((__always_inline__)) size_t adjust_request_size(size
** the documentation found in the white paper.
*/

static inline __attribute__((__always_inline__)) void mapping_insert(size_t size, int* fli, int* sli)
static inline __attribute__((__always_inline__)) void mapping_insert(control_t *control, size_t size, int* fli, int* sli)
{
int fl, sl;
if (size < SMALL_BLOCK_SIZE)
if (size < control->small_block_size)
{
/* Store small blocks in first list. */
fl = 0;
Expand All @@ -153,22 +147,22 @@ static inline __attribute__((__always_inline__)) void mapping_insert(size_t size
else
{
fl = tlsf_fls(size);
sl = tlsf_cast(int, size >> (fl - SL_INDEX_COUNT_LOG2)) ^ (1 << SL_INDEX_COUNT_LOG2);
fl -= (FL_INDEX_SHIFT - 1);
sl = tlsf_cast(int, size >> (fl - control->sl_index_count_log2)) ^ (1 << control->sl_index_count_log2);
fl -= (control->fl_index_shift - 1);
}
*fli = fl;
*sli = sl;
}

/* This version rounds up to the next block size (for allocations) */
static inline __attribute__((__always_inline__)) void mapping_search(size_t size, int* fli, int* sli)
static inline __attribute__((__always_inline__)) void mapping_search(control_t *control, size_t size, int* fli, int* sli)
{
if (size >= SMALL_BLOCK_SIZE)
if (size >= control->small_block_size)
{
const size_t round = (1 << (tlsf_fls(size) - SL_INDEX_COUNT_LOG2)) - 1;
const size_t round = (1 << (tlsf_fls(size) - control->sl_index_count_log2)) - 1;
size += round;
}
mapping_insert(size, fli, sli);
mapping_insert(control, size, fli, sli);
}

static inline __attribute__((__always_inline__)) block_header_t* search_suitable_block(control_t* control, int* fli, int* sli)
Expand Down Expand Up @@ -200,7 +194,7 @@ static inline __attribute__((__always_inline__)) block_header_t* search_suitable
*sli = sl;

/* Return the first block in the free list. */
return control->blocks[fl][sl];
return control->blocks[fl*control->sl_index_count + sl];
}

/* Remove a free block from the free list.*/
Expand All @@ -214,9 +208,9 @@ static inline __attribute__((__always_inline__)) void remove_free_block(control_
prev->next_free = next;

/* If this block is the head of the free list, set new head. */
if (control->blocks[fl][sl] == block)
if (control->blocks[fl*control->sl_index_count + sl] == block)
{
control->blocks[fl][sl] = next;
control->blocks[fl*control->sl_index_count + sl] = next;

/* If the new head is null, clear the bitmap. */
if (next == &control->block_null)
Expand All @@ -235,7 +229,7 @@ static inline __attribute__((__always_inline__)) void remove_free_block(control_
/* Insert a free block into the free block list. */
static inline __attribute__((__always_inline__)) void insert_free_block(control_t* control, block_header_t* block, int fl, int sl)
{
block_header_t* current = control->blocks[fl][sl];
block_header_t* current = control->blocks[fl*control->sl_index_count + sl];
tlsf_assert(current && "free list cannot have a null entry");
tlsf_assert(block && "cannot insert a null entry into the free list");
block->next_free = current;
Expand All @@ -248,7 +242,7 @@ static inline __attribute__((__always_inline__)) void insert_free_block(control_
** Insert the new block at the head of the list, and mark the first-
** and second-level bitmaps appropriately.
*/
control->blocks[fl][sl] = block;
control->blocks[fl*control->sl_index_count + sl] = block;
control->fl_bitmap |= (1 << fl);
control->sl_bitmap[fl] |= (1 << sl);
}
Expand All @@ -257,15 +251,15 @@ static inline __attribute__((__always_inline__)) void insert_free_block(control_
static inline __attribute__((__always_inline__)) void block_remove(control_t* control, block_header_t* block)
{
int fl, sl;
mapping_insert(block_size(block), &fl, &sl);
mapping_insert(control, block_size(block), &fl, &sl);
remove_free_block(control, block, fl, sl);
}

/* Insert a given block into the free list. */
static inline __attribute__((__always_inline__)) void block_insert(control_t* control, block_header_t* block)
{
int fl, sl;
mapping_insert(block_size(block), &fl, &sl);
mapping_insert(control, block_size(block), &fl, &sl);
insert_free_block(control, block, fl, sl);
}

Expand Down Expand Up @@ -428,15 +422,15 @@ static inline __attribute__((__always_inline__)) block_header_t* block_locate_f

if (size)
{
mapping_search(size, &fl, &sl);
mapping_search(control, size, &fl, &sl);

/*
** mapping_search can futz with the size, so for excessively large sizes it can sometimes wind up
** with indices that are off the end of the block array.
** So, we protect against that here, since this is the only callsite of mapping_search.
** Note that we don't need to check sl, since it comes from a modulo operation that guarantees it's always in range.
*/
if (fl < FL_INDEX_COUNT)
if (fl < control->fl_index_count)
{
block = search_suitable_block(control, &fl, &sl);
}
Expand Down Expand Up @@ -465,20 +459,44 @@ static inline __attribute__((__always_inline__)) void* block_prepare_used(contro
}

/* Clear structure and point all empty lists at the null block. */
static void control_construct(control_t* control)
static void control_construct(control_t* control, size_t bytes)
{
int i, j;

control->block_null.next_free = &control->block_null;
control->block_null.prev_free = &control->block_null;

/* find the closest ^2 for first layer */
i = (bytes - 1) / (16 * 1024);
for (control->fl_index_max = FL_INDEX_MAX_MIN; i >>= 1; control->fl_index_max++);

/* adapt second layer to the pool */
if (bytes < 16 * 1024) control->sl_index_count_log2 = 3;
else if (bytes < 256 * 1024) control->sl_index_count_log2 = 4;
else control->sl_index_count_log2 = 5;

control->fl_index_shift = (control->sl_index_count_log2 + ALIGN_SIZE_LOG2);
control->sl_index_count = 1 << control->sl_index_count_log2;
control->fl_index_count = control->fl_index_max - control->fl_index_shift + 1;
control->small_block_size = 1 << control->fl_index_shift;
control->fl_bitmap = 0;
for (i = 0; i < FL_INDEX_COUNT; ++i)

control->sl_bitmap = align_ptr(control + 1, sizeof(*control->sl_bitmap));
control->blocks = align_ptr(control->sl_bitmap + control->fl_index_count, sizeof(*control->blocks));
control->size = (void*) (control->blocks + control->sl_index_count * control->fl_index_count) - (void*) control;

/* SL_INDEX_COUNT must be <= number of bits in sl_bitmap's storage type. */
tlsf_assert(sizeof(unsigned int) * CHAR_BIT >= control->sl_index_count && "CHAR_BIT less than sl_index_count");

/* Ensure we've properly tuned our sizes. */
tlsf_assert(ALIGN_SIZE == control->small_block_size / control->sl_index_count && "ALIGN_SIZE does not match");

for (i = 0; i < control->fl_index_count; ++i)
{
control->sl_bitmap[i] = 0;
for (j = 0; j < SL_INDEX_COUNT; ++j)
for (j = 0; j < control->sl_index_count; ++j)
{
control->blocks[i][j] = &control->block_null;
control->blocks[i*control->sl_index_count + j] = &control->block_null;
}
}
}
Expand Down Expand Up @@ -520,14 +538,14 @@ int tlsf_check(tlsf_t tlsf)
int status = 0;

/* Check that the free lists and bitmaps are accurate. */
for (i = 0; i < FL_INDEX_COUNT; ++i)
for (i = 0; i < control->fl_index_count; ++i)
{
for (j = 0; j < SL_INDEX_COUNT; ++j)
for (j = 0; j < control->sl_index_count; ++j)
{
const int fl_map = control->fl_bitmap & (1 << i);
const int sl_list = control->sl_bitmap[i];
const int sl_map = sl_list & (1 << j);
const block_header_t* block = control->blocks[i][j];
const block_header_t* block = control->blocks[i*control->sl_index_count + j];

/* Check that first- and second-level lists agree. */
if (!fl_map)
Expand All @@ -554,7 +572,7 @@ int tlsf_check(tlsf_t tlsf)
tlsf_insist(block_is_prev_free(block_next(block)) && "block should be free");
tlsf_insist(block_size(block) >= block_size_min && "block not minimum size");

mapping_insert(block_size(block), &fli, &sli);
mapping_insert(control, block_size(block), &fli, &sli);
tlsf_insist(fli == i && sli == j && "block size indexed in wrong list");
block = block->next_free;
}
Expand Down Expand Up @@ -613,9 +631,18 @@ int tlsf_check_pool(pool_t pool)
** Size of the TLSF structures in a given memory block passed to
** tlsf_create, equal to the size of a control_t
*/
size_t tlsf_size(void)
size_t tlsf_size(tlsf_t tlsf)
{
return sizeof(control_t);
if (tlsf)
{
control_t* control = tlsf_cast(control_t*, tlsf);
return control->size;
}

/* no tlsf, we'll just return a min size */
return sizeof(control_t) +
sizeof(int) * SL_INDEX_COUNT_MIN +
sizeof(block_header_t*) * SL_INDEX_COUNT_MIN * FL_INDEX_COUNT_MIN;
}

size_t tlsf_align_size(void)
Expand All @@ -628,9 +655,10 @@ size_t tlsf_block_size_min(void)
return block_size_min;
}

size_t tlsf_block_size_max(void)
size_t tlsf_block_size_max(tlsf_t tlsf)
{
return block_size_max;
control_t* control = tlsf_cast(control_t*, tlsf);
return tlsf_cast(size_t, 1) << control->fl_index_max;
}

/*
Expand Down Expand Up @@ -663,16 +691,16 @@ pool_t tlsf_add_pool(tlsf_t tlsf, void* mem, size_t bytes)
return 0;
}

if (pool_bytes < block_size_min || pool_bytes > block_size_max)
if (pool_bytes < block_size_min || pool_bytes > tlsf_block_size_max(tlsf))
{
#if defined (TLSF_64BIT)
printf("tlsf_add_pool: Memory size must be between 0x%x and 0x%x00 bytes.\n",
(unsigned int)(pool_overhead + block_size_min),
(unsigned int)((pool_overhead + block_size_max) / 256));
(unsigned int)((pool_overhead + tlsf_block_size_max(tlsf)) / 256));
#else
printf("tlsf_add_pool: Memory size must be between %u and %u bytes.\n",
(unsigned int)(pool_overhead + block_size_min),
(unsigned int)(pool_overhead + block_size_max));
(unsigned int)(pool_overhead + tlsf_block_size_max(tlsf)));
#endif
return 0;
}
Expand Down Expand Up @@ -708,7 +736,7 @@ void tlsf_remove_pool(tlsf_t tlsf, pool_t pool)
tlsf_assert(!block_is_free(block_next(block)) && "next block should not be free");
tlsf_assert(block_size(block_next(block)) == 0 && "next block size should be zero");

mapping_insert(block_size(block), &fl, &sl);
mapping_insert(control, block_size(block), &fl, &sl);
remove_free_block(control, block, fl, sl);
}

Expand All @@ -717,7 +745,7 @@ void tlsf_remove_pool(tlsf_t tlsf, pool_t pool)
*/


tlsf_t tlsf_create(void* mem)
tlsf_t tlsf_create(void* mem, size_t bytes)
{
#if _DEBUG
if (test_ffs_fls())
Expand All @@ -733,27 +761,28 @@ tlsf_t tlsf_create(void* mem)
return 0;
}

control_construct(tlsf_cast(control_t*, mem));
control_construct(tlsf_cast(control_t*, mem), bytes);

return tlsf_cast(tlsf_t, mem);
}

pool_t tlsf_get_pool(tlsf_t tlsf)
{
return tlsf_cast(pool_t, (char*)tlsf + tlsf_size());
return tlsf_cast(pool_t, (char*)tlsf + tlsf_size(tlsf));
}

tlsf_t tlsf_create_with_pool(void* mem, size_t bytes)
{
tlsf_t tlsf = tlsf_create(mem);
tlsf_add_pool(tlsf, (char*)mem + tlsf_size(), bytes - tlsf_size());
tlsf_t tlsf = tlsf_create(mem, bytes);
tlsf_add_pool(tlsf, (char*)mem + tlsf_size(tlsf), bytes - tlsf_size(tlsf));
control_t *control = tlsf_cast(control_t*, tlsf);
return tlsf;
}

void* tlsf_malloc(tlsf_t tlsf, size_t size)
{
control_t* control = tlsf_cast(control_t*, tlsf);
size_t adjust = adjust_request_size(size, ALIGN_SIZE);
size_t adjust = adjust_request_size(tlsf, size, ALIGN_SIZE);
block_header_t* block = block_locate_free(control, adjust);
return block_prepare_used(control, block, adjust);
}
Expand Down Expand Up @@ -784,7 +813,7 @@ void* tlsf_malloc(tlsf_t tlsf, size_t size)
void* tlsf_memalign_offs(tlsf_t tlsf, size_t align, size_t size, size_t data_offset)
{
control_t* control = tlsf_cast(control_t*, tlsf);
const size_t adjust = adjust_request_size(size, ALIGN_SIZE);
const size_t adjust = adjust_request_size(tlsf, size, ALIGN_SIZE);
const size_t off_adjust = align_up(data_offset, ALIGN_SIZE);

/*
Expand All @@ -799,7 +828,7 @@ void* tlsf_memalign_offs(tlsf_t tlsf, size_t align, size_t size, size_t data_off
/* The offset is included in both `adjust` and `gap_minimum`, so we
** need to subtract it once.
*/
const size_t size_with_gap = adjust_request_size(adjust + align + gap_minimum - off_adjust, align);
const size_t size_with_gap = adjust_request_size(tlsf, adjust + align + gap_minimum - off_adjust, align);

/*
** If alignment is less than or equals base alignment, we're done.
Expand Down Expand Up @@ -906,7 +935,7 @@ void* tlsf_realloc(tlsf_t tlsf, void* ptr, size_t size)

const size_t cursize = block_size(block);
const size_t combined = cursize + block_size(next) + block_header_overhead;
const size_t adjust = adjust_request_size(size, ALIGN_SIZE);
const size_t adjust = adjust_request_size(tlsf, size, ALIGN_SIZE);

tlsf_assert(!block_is_free(block) && "block already marked as free");

Expand Down
Loading

0 comments on commit beb15f7

Please sign in to comment.