From 7bf547a9280973e96a21ff9b5165f69051f60c19 Mon Sep 17 00:00:00 2001 From: Xiang Xiao Date: Wed, 10 Mar 2021 22:13:35 +0800 Subject: [PATCH] feat(mem): switch the default allocator to tlsf (#2129) * feat(mem): add initial version of tlsf from : https://github.com/mattconte/tlsf commit: deff9ab509341f264addbd3c8ada533678591905 * feat(mem): switch the default allocator to tlsf * fix(mem): remove the preserved small buffer since the builtin allocator(tlsf) is fast enough now * fix(mem): change LV_MEM_ADD_JUNK to 0 to speed up the normal operation --- src/lv_misc/lv_mem.c | 394 +-------- src/lv_misc/lv_mem.h | 7 +- src/lv_misc/lv_misc.mk | 1 + src/lv_misc/lv_tlsf.c | 1290 ++++++++++++++++++++++++++++ src/lv_misc/lv_tlsf.h | 95 ++ tests/lv_test_core/lv_test_style.c | 5 - 6 files changed, 1434 insertions(+), 358 deletions(-) create mode 100644 src/lv_misc/lv_tlsf.c create mode 100644 src/lv_misc/lv_tlsf.h diff --git a/src/lv_misc/lv_mem.c b/src/lv_misc/lv_mem.c index 1c9229e02..df6035cc7 100644 --- a/src/lv_misc/lv_mem.c +++ b/src/lv_misc/lv_mem.c @@ -8,7 +8,7 @@ * INCLUDES *********************/ #include "lv_mem.h" -#include "lv_math.h" +#include "lv_tlsf.h" #include "lv_gc.h" #include "lv_assert.h" #include @@ -23,81 +23,38 @@ *********************/ /*Add memory junk on alloc (0xaa) and free(0xbb) (just for testing purposes)*/ #ifndef LV_MEM_ADD_JUNK -# define LV_MEM_ADD_JUNK 1 -#endif - -#ifndef LV_MEM_FULL_DEFRAG_CNT -# define LV_MEM_FULL_DEFRAG_CNT 64 +# define LV_MEM_ADD_JUNK 0 #endif #ifdef LV_ARCH_64 -# define MEM_UNIT uint64_t +# define MEM_UNIT uint64_t +# define ALIGN_MASK 0x7 #else -# define MEM_UNIT uint32_t +# define MEM_UNIT uint32_t +# define ALIGN_MASK 0x7 #endif +#define ZERO_MEM_SENTINEL 0xa1b2c3d4 + /********************** * TYPEDEFS **********************/ -#if LV_ENABLE_GC == 0 /*gc custom allocations must not include header*/ - -/*The size of this union must be 4/8 bytes (uint32_t/uint64_t)*/ -typedef union { - struct { - MEM_UNIT used : 1; /* 1: if the entry is used*/ - MEM_UNIT d_size : 31; /* Size of the data*/ - } s; - MEM_UNIT header; /* The header (used + d_size)*/ -} lv_mem_header_t; - -typedef struct { - lv_mem_header_t header; - uint8_t first_data; /*First data byte in the allocated data (Just for easily create a pointer)*/ -} lv_mem_ent_t; - -#endif /* LV_ENABLE_GC */ - -#ifdef LV_ARCH_64 - #define ALIGN_MASK 0x7 -#else - #define ALIGN_MASK 0x3 -#endif - -#define MEM_BUF_SMALL_SIZE 16 - -#define ZERO_MEM_SENTINEL 0xa1b2c3d4 - /********************** * STATIC PROTOTYPES **********************/ #if LV_MEM_CUSTOM == 0 - static void * alloc_core(size_t size); - static lv_mem_ent_t * ent_get_next(lv_mem_ent_t * act_e); - static inline void * ent_alloc(lv_mem_ent_t * e, size_t size); - static void ent_trunc(lv_mem_ent_t * e, size_t size); - static size_t get_size(void * data_p); + static void lv_mem_walker(void * ptr, size_t size, int used, void * user); #endif /********************** * STATIC VARIABLES **********************/ #if LV_MEM_CUSTOM == 0 - static uint8_t * work_mem; + static tlsf_t tlsf; #endif static uint32_t zero_mem = ZERO_MEM_SENTINEL; /*Give the address of this variable if 0 byte should be allocated*/ -#if LV_MEM_CUSTOM == 0 - static uint8_t * last_mem; /*Address of the last valid byte*/ - static uint32_t mem_max_size; /*Tracks the maximum total size of memory ever used from the internal heap*/ -#endif - -static uint8_t mem_buf1_32[MEM_BUF_SMALL_SIZE]; -static uint8_t mem_buf2_32[MEM_BUF_SMALL_SIZE]; - -static lv_mem_buf_t mem_buf_small[] = {{.p = mem_buf1_32, .size = MEM_BUF_SMALL_SIZE, .used = 0}, - {.p = mem_buf2_32, .size = MEM_BUF_SMALL_SIZE, .used = 0} -}; /********************** * MACROS @@ -128,15 +85,10 @@ void lv_mem_init(void) #if LV_MEM_ADR == 0 /*Allocate a large array to store the dynamically allocated data*/ static LV_ATTRIBUTE_LARGE_RAM_ARRAY MEM_UNIT work_mem_int[LV_MEM_SIZE / sizeof(MEM_UNIT)]; - work_mem = (uint8_t *)work_mem_int; + tlsf = tlsf_create_with_pool((void *)work_mem_int, LV_MEM_SIZE); #else - work_mem = (uint8_t *)LV_MEM_ADR; + tlsf = tlsf_create_with_pool((void *)LV_MEM_ADR, LV_MEM_SIZE); #endif - last_mem = &work_mem[LV_MEM_SIZE - 1]; - lv_mem_ent_t * full = (lv_mem_ent_t *)work_mem; - full->header.s.used = 0; - /*The total mem size reduced by the first header and the close patterns */ - full->header.s.d_size = LV_MEM_SIZE - sizeof(lv_mem_header_t); #endif #if LV_MEM_ADD_JUNK @@ -151,11 +103,8 @@ void lv_mem_init(void) void lv_mem_deinit(void) { #if LV_MEM_CUSTOM == 0 - lv_memset_00(work_mem, (LV_MEM_SIZE / sizeof(MEM_UNIT)) * sizeof(MEM_UNIT)); - lv_mem_ent_t * full = (lv_mem_ent_t *)work_mem; - full->header.s.used = 0; - /*The total mem size reduced by the first header and the close patterns */ - full->header.s.d_size = LV_MEM_SIZE - sizeof(lv_mem_header_t); + tlsf_destroy(tlsf); + lv_mem_init(); #endif } @@ -172,24 +121,11 @@ void * lv_mem_alloc(size_t size) return &zero_mem; } - /*Round the size up to ALIGN_MASK*/ - size = (size + ALIGN_MASK) & (~ALIGN_MASK); - void * alloc = NULL; - #if LV_MEM_CUSTOM == 0 - alloc = alloc_core(size); - if(alloc == NULL) { - LV_LOG_WARN("out of memory, trying to defrag"); - lv_mem_defrag(); - alloc = alloc_core(size); - if(alloc) { - LV_LOG_INFO("defrag made enough memory, memory allocated successfully"); - } - } - + void * alloc = tlsf_malloc(tlsf, size); #else - alloc = LV_MEM_CUSTOM_ALLOC(size); -#endif /* LV_MEM_CUSTOM */ + void * alloc = LV_MEM_CUSTOM_ALLOC(size); +#endif #if LV_MEM_ADD_JUNK if(alloc != NULL) lv_memset(alloc, 0xaa, size); @@ -203,16 +139,6 @@ void * lv_mem_alloc(size_t size) (int)mon.total_size - mon.free_size, mon.used_pct, mon.frag_pct, (int)mon.free_biggest_size); } - else { -#if LV_MEM_CUSTOM == 0 - /* just a safety check, should always be true */ - if((uintptr_t) alloc > (uintptr_t) work_mem) { - if((((uintptr_t) alloc - (uintptr_t) work_mem) + size) > mem_max_size) { - mem_max_size = ((uintptr_t) alloc - (uintptr_t) work_mem) + size; - } - } -#endif - } MEM_TRACE("allocated at 0x%p", alloc); return alloc; @@ -229,21 +155,11 @@ void lv_mem_free(void * data) if(data == NULL) return; #if LV_MEM_CUSTOM == 0 - lv_mem_ent_t * e = (lv_mem_ent_t *)((uint8_t *)data - sizeof(lv_mem_header_t)); - e->header.s.used = 0; # if LV_MEM_ADD_JUNK - lv_memset((void *)data, 0xbb, e->header.s.d_size); + lv_memset(data, 0xbb, tlsf_block_size(data)); # endif - - static uint32_t defr = 0; - defr++; - if(defr > LV_MEM_FULL_DEFRAG_CNT) { - MEM_TRACE("performing auto defrag") - defr = 0; - lv_mem_defrag(); - } + tlsf_free(tlsf, data); #else - /*e points to the header*/ LV_MEM_CUSTOM_FREE(data); #endif } @@ -258,120 +174,26 @@ void lv_mem_free(void * data) void * lv_mem_realloc(void * data_p, size_t new_size) { MEM_TRACE("reallocating 0x%p with %d size", data_p, new_size); - void * new_p = NULL; -#if LV_MEM_CUSTOM if(new_size == 0) { MEM_TRACE("using zero_mem"); - LV_MEM_CUSTOM_FREE(data_p); + lv_mem_free(data_p); return &zero_mem; } - if(data_p == &zero_mem) new_p = LV_MEM_CUSTOM_ALLOC(new_size); - else new_p = LV_MEM_CUSTOM_REALLOC(data_p, new_size); + if(data_p == &zero_mem) return lv_mem_alloc(new_size); - if(new_p == NULL) { - LV_LOG_ERROR("couldn't allocate memory"); - return NULL; - } else { - MEM_TRACE("allocated at 0x%p", new_p); - return new_p; - } +#if LV_MEM_CUSTOM == 0 + void * new_p = tlsf_realloc(tlsf, data_p, new_size); #else - - /*Round the size up to ALIGN_MASK*/ - new_size = (new_size + ALIGN_MASK) & (~ALIGN_MASK); - - /*data_p could be previously freed pointer (in this case it is invalid)*/ - if(data_p != NULL) { - lv_mem_ent_t * e = (lv_mem_ent_t *)((uint8_t *)data_p - sizeof(lv_mem_header_t)); - if(e->header.s.used == 0) { - data_p = NULL; - } - } - - uint32_t old_size = get_size(data_p); - - if(old_size == new_size) { - MEM_TRACE("same size, using the original memory"); - return data_p; - } - - if(new_size == 0) { - lv_mem_free(data_p); - return &zero_mem; - } - /* Truncate the memory if the new size is smaller. */ - if(new_size < old_size) { - lv_mem_ent_t * e = (lv_mem_ent_t *)((uint8_t *)data_p - sizeof(lv_mem_header_t)); - ent_trunc(e, new_size); - MEM_TRACE("memory entry is truncated (same address 0x%p is used)", &e->first_data); - return &e->first_data; - } - - new_p = lv_mem_alloc(new_size); + void * new_p = LV_MEM_CUSTOM_REALLOC(data_p, new_size); +#endif if(new_p == NULL) { LV_LOG_ERROR("couldn't allocate memory"); return NULL; } - if(data_p != NULL) { - /*Copy the old data to the new. Use the smaller size*/ - if(old_size != 0 && new_size != 0) { - lv_memcpy(new_p, data_p, LV_MIN(new_size, old_size)); - } - lv_mem_free(data_p); - } - MEM_TRACE("allocated at 0x%p", new_p); return new_p; -#endif -} - -/** - * Join the adjacent free memory blocks - */ -void lv_mem_defrag(void) -{ - MEM_TRACE("begin"); -#if LV_MEM_CUSTOM == 0 - lv_mem_ent_t * e_free; - lv_mem_ent_t * e_next; - e_free = ent_get_next(NULL); - - while(1) { - /*Search the next free entry*/ - while(e_free != NULL) { - if(e_free->header.s.used != 0) e_free = ent_get_next(e_free); - else break; - } - - if(e_free == NULL) { - MEM_TRACE("finished"); - return; - } - - /*Joint the following free entries to the free*/ - e_next = ent_get_next(e_free); - while(e_next != NULL) { - if(e_next->header.s.used == 0) { - e_free->header.s.d_size += e_next->header.s.d_size + sizeof(e_next->header); - } - else { - break; - } - - e_next = ent_get_next(e_next); - } - - if(e_next == NULL) { - MEM_TRACE("finished"); - return; - } - - /*Continue from the lastly checked entry*/ - e_free = e_next; - } -#endif } lv_res_t lv_mem_test(void) @@ -382,19 +204,14 @@ lv_res_t lv_mem_test(void) } #if LV_MEM_CUSTOM == 0 - lv_mem_ent_t * e; - e = ent_get_next(NULL); - while(e) { - if(e->header.s.d_size > LV_MEM_SIZE) { - LV_LOG_WARN("failed"); - return LV_RES_INV; - } - uint8_t * e8 = (uint8_t *)e; - if(e8 + e->header.s.d_size > work_mem + LV_MEM_SIZE) { - LV_LOG_WARN("failed"); - return LV_RES_INV; - } - e = ent_get_next(e); + if(tlsf_check(tlsf)) { + LV_LOG_WARN("failed"); + return LV_RES_INV; + } + + if (tlsf_check_pool(tlsf_get_pool(tlsf))) { + LV_LOG_WARN("pool failed"); + return LV_RES_INV; } #endif MEM_TRACE("passed"); @@ -412,26 +229,10 @@ void lv_mem_monitor(lv_mem_monitor_t * mon_p) lv_memset(mon_p, 0, sizeof(lv_mem_monitor_t)); #if LV_MEM_CUSTOM == 0 MEM_TRACE("begin"); - lv_mem_ent_t * e; - e = ent_get_next(NULL); + tlsf_walk_pool(tlsf_get_pool(tlsf), lv_mem_walker, mon_p); - while(e != NULL) { - if(e->header.s.used == 0) { - mon_p->free_cnt++; - mon_p->free_size += e->header.s.d_size; - if(e->header.s.d_size > mon_p->free_biggest_size) { - mon_p->free_biggest_size = e->header.s.d_size; - } - } - else { - mon_p->used_cnt++; - } - - e = ent_get_next(e); - } mon_p->total_size = LV_MEM_SIZE; - mon_p->max_used = mem_max_size; mon_p->used_pct = 100 - (100U * mon_p->free_size) / mon_p->total_size; if(mon_p->free_size > 0) { mon_p->frag_pct = mon_p->free_biggest_size * 100U / mon_p->free_size; @@ -455,21 +256,10 @@ void * lv_mem_buf_get(uint32_t size) if(size == 0) return NULL; MEM_TRACE("begin, getting %d bytes", size); - /*Try small static buffers first*/ - uint8_t i; - if(size <= MEM_BUF_SMALL_SIZE) { - for(i = 0; i < sizeof(mem_buf_small) / sizeof(mem_buf_small[0]); i++) { - if(mem_buf_small[i].used == 0) { - mem_buf_small[i].used = 1; - MEM_TRACE("return using small static buffer"); - return mem_buf_small[i].p; - } - } - } /*Try to find a free buffer with suitable size */ int8_t i_guess = -1; - for(i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { + for(uint8_t i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { if(LV_GC_ROOT(lv_mem_buf[i]).used == 0 && LV_GC_ROOT(lv_mem_buf[i]).size >= size) { if(LV_GC_ROOT(lv_mem_buf[i]).size == size) { LV_GC_ROOT(lv_mem_buf[i]).used = 1; @@ -492,7 +282,7 @@ void * lv_mem_buf_get(uint32_t size) } /*Reallocate a free buffer*/ - for(i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { + for(uint8_t i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { if(LV_GC_ROOT(lv_mem_buf[i]).used == 0) { /*if this fails you probably need to increase your LV_MEM_SIZE/heap size*/ void * buf = lv_mem_realloc(LV_GC_ROOT(lv_mem_buf[i]).p, size); @@ -519,18 +309,8 @@ void * lv_mem_buf_get(uint32_t size) void lv_mem_buf_release(void * p) { MEM_TRACE("begin (address: 0x%p)", p); - uint8_t i; - /*Try small static buffers first*/ - for(i = 0; i < sizeof(mem_buf_small) / sizeof(mem_buf_small[0]); i++) { - if(mem_buf_small[i].p == p) { - mem_buf_small[i].used = 0; - MEM_TRACE("released (buffer id: %d)", i); - return; - } - } - - for(i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { + for(uint8_t i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { if(LV_GC_ROOT(lv_mem_buf[i]).p == p) { LV_GC_ROOT(lv_mem_buf[i]).used = 0; return; @@ -545,12 +325,7 @@ void lv_mem_buf_release(void * p) */ void lv_mem_buf_free_all(void) { - uint8_t i; - for(i = 0; i < sizeof(mem_buf_small) / sizeof(mem_buf_small[0]); i++) { - mem_buf_small[i].used = 0; - } - - for(i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { + for(uint8_t i = 0; i < LV_MEM_BUF_MAX_NUM; i++) { if(LV_GC_ROOT(lv_mem_buf[i]).p) { lv_mem_free(LV_GC_ROOT(lv_mem_buf[i]).p); LV_GC_ROOT(lv_mem_buf[i]).p = NULL; @@ -750,94 +525,19 @@ LV_ATTRIBUTE_FAST_MEM void lv_memset_ff(void * dst, size_t len) **********************/ #if LV_MEM_CUSTOM == 0 - -static void * alloc_core(size_t size) +static void lv_mem_walker(void * ptr, size_t size, int used, void * user) { - lv_mem_ent_t * e = NULL; + LV_UNUSED(ptr); - /* Search for a appropriate entry*/ - while(1) { - /* Get the next entry*/ - e = ent_get_next(e); - if( e == NULL) break; - - /*If there is next entry then try to allocate there*/ - if(!e->header.s.used && e->header.s.d_size >= size) - return ent_alloc(e, size); + lv_mem_monitor_t * mon_p = user; + if(used) { + mon_p->used_cnt++; } - - return NULL; -} - -/** - * Give the next entry after 'act_e' - * @param act_e pointer to an entry - * @return pointer to an entry after 'act_e' - */ -static lv_mem_ent_t * ent_get_next(lv_mem_ent_t * act_e) -{ - /*NULL means: get the first entry; else get the next after `act_e`*/ - if(act_e == NULL) return (lv_mem_ent_t *)work_mem; else { - uint8_t * data = &act_e->first_data; - lv_mem_ent_t * next_e = (lv_mem_ent_t *)&data[act_e->header.s.d_size]; - - if(&next_e->first_data > last_mem) return NULL; - else return next_e; + mon_p->free_cnt++; + mon_p->free_size += size; + if(size > mon_p->free_biggest_size) + mon_p->free_biggest_size = size; } } - -/** - * Try to do the real allocation with a given size - * @param e try to allocate to this entry - * @param size size of the new memory in bytes - * @return pointer to the allocated memory or NULL if not enough memory in the entry - */ -static inline void * ent_alloc(lv_mem_ent_t * e, size_t size) -{ - /*Truncate the entry to the desired size */ - ent_trunc(e, size); - e->header.s.used = 1; - - /*Save the allocated data*/ - return &e->first_data; -} - -/** - * Truncate the data of entry to the given size - * @param e Pointer to an entry - * @param size new size in bytes - */ -static void ent_trunc(lv_mem_ent_t * e, size_t size) -{ - /*Round the size up to ALIGN_MASK*/ - size = (size + ALIGN_MASK) & (~ALIGN_MASK); - - /*Don't let empty space only for a header without data*/ - if(e->header.s.d_size == size + sizeof(lv_mem_header_t)) { - size = e->header.s.d_size; - } - - /* Create the new entry after the current if there is space for it */ - if(e->header.s.d_size != size) { - uint8_t * e_data = &e->first_data; - lv_mem_ent_t * after_new_e = (lv_mem_ent_t *)&e_data[size]; - after_new_e->header.s.used = 0; - after_new_e->header.s.d_size = e->header.s.d_size - size - sizeof(lv_mem_header_t); - - /* Set the new size for the original entry */ - e->header.s.d_size = size; - } -} - -static size_t get_size(void * data_p) -{ - if(data_p == NULL) return 0; - if(data_p == &zero_mem) return 0; - - lv_mem_ent_t * e = (lv_mem_ent_t *)((uint8_t *)data_p - sizeof(lv_mem_header_t)); - - return e->header.s.d_size; -} - #endif diff --git a/src/lv_misc/lv_mem.h b/src/lv_misc/lv_mem.h index 370226832..c2706b538 100644 --- a/src/lv_misc/lv_mem.h +++ b/src/lv_misc/lv_mem.h @@ -53,7 +53,7 @@ typedef struct { typedef struct { void * p; uint16_t size; - uint8_t used : 1; + uint8_t used : 1; } lv_mem_buf_t; typedef lv_mem_buf_t lv_mem_buf_arr_t[LV_MEM_BUF_MAX_NUM]; @@ -95,11 +95,6 @@ void lv_mem_free(void * data); */ void * lv_mem_realloc(void * data_p, size_t new_size); -/** - * Join the adjacent free memory blocks - */ -void lv_mem_defrag(void); - /** * * @return diff --git a/src/lv_misc/lv_misc.mk b/src/lv_misc/lv_misc.mk index ebaf6496e..0501212c3 100644 --- a/src/lv_misc/lv_misc.mk +++ b/src/lv_misc/lv_misc.mk @@ -12,6 +12,7 @@ CSRCS += lv_mem.c CSRCS += lv_printf.c CSRCS += lv_style.c CSRCS += lv_timer.c +CSRCS += lv_tlsf.c CSRCS += lv_txt.c CSRCS += lv_txt_ap.c CSRCS += lv_utils.c diff --git a/src/lv_misc/lv_tlsf.c b/src/lv_misc/lv_tlsf.c new file mode 100644 index 000000000..1c605edd7 --- /dev/null +++ b/src/lv_misc/lv_tlsf.c @@ -0,0 +1,1290 @@ +#include "../lv_conf_internal.h" +#if LV_MEM_CUSTOM == 0 + +#include +#include +#include +#include +#include +#include + +#include "lv_tlsf.h" + +#include "lv_log.h" +#define printf LV_LOG_ERROR + +#define TLSF_MAX_POOL_SIZE LV_MEM_SIZE + +#if !defined(_DEBUG) +#define _DEBUG 0 +#endif + +#if defined(__cplusplus) +#define tlsf_decl inline +#else +#define tlsf_decl static +#endif + +/* +** Architecture-specific bit manipulation routines. +** +** TLSF achieves O(1) cost for malloc and free operations by limiting +** the search for a free block to a free list of guaranteed size +** adequate to fulfill the request, combined with efficient free list +** queries using bitmasks and architecture-specific bit-manipulation +** routines. +** +** Most modern processors provide instructions to count leading zeroes +** in a word, find the lowest and highest set bit, etc. These +** specific implementations will be used when available, falling back +** to a reasonably efficient generic implementation. +** +** NOTE: TLSF spec relies on ffs/fls returning value 0..31. +** ffs/fls return 1-32 by default, returning 0 for error. +*/ + +/* +** Detect whether or not we are building for a 32- or 64-bit (LP/LLP) +** architecture. There is no reliable portable method at compile-time. +*/ +#if defined (__alpha__) || defined (__ia64__) || defined (__x86_64__) \ + || defined (_WIN64) || defined (__LP64__) || defined (__LLP64__) +#define TLSF_64BIT +#endif + +/* +** Returns one plus the index of the most significant 1-bit of n, +** or if n is zero, returns zero. +*/ +#ifdef TLSF_64BIT +#define TLSF_FLS(n) ((n) & 0xffffffff00000000ull ? 32 + TLSF_FLS32((size_t)(n) >> 32) : TLSF_FLS32(n)) +#else +#define TLSF_FLS(n) TLSF_FLS32(n) +#endif + +#define TLSF_FLS32(n) ((n) & 0xffff0000 ? 16 + TLSF_FLS16((n) >> 16) : TLSF_FLS16(n)) +#define TLSF_FLS16(n) ((n) & 0xff00 ? 8 + TLSF_FLS8 ((n) >> 8) : TLSF_FLS8 (n)) +#define TLSF_FLS8(n) ((n) & 0xf0 ? 4 + TLSF_FLS4 ((n) >> 4) : TLSF_FLS4 (n)) +#define TLSF_FLS4(n) ((n) & 0xc ? 2 + TLSF_FLS2 ((n) >> 2) : TLSF_FLS2 (n)) +#define TLSF_FLS2(n) ((n) & 0x2 ? 1 + TLSF_FLS1 ((n) >> 1) : TLSF_FLS1 (n)) +#define TLSF_FLS1(n) ((n) & 0x1 ? 1 : 0) + +/* +** Returns round up value of log2(n). +** Note: it is used at compile time. +*/ +#define TLSF_LOG2_CEIL(n) ((n) & (n - 1) ? TLSF_FLS(n) : TLSF_FLS(n) - 1) + +/* +** gcc 3.4 and above have builtin support, specialized for architecture. +** Some compilers masquerade as gcc; patchlevel test filters them out. +*/ +#if defined (__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)) \ + && defined (__GNUC_PATCHLEVEL__) + +#if defined (__SNC__) +/* SNC for Playstation 3. */ + +tlsf_decl int tlsf_ffs(unsigned int word) +{ + const unsigned int reverse = word & (~word + 1); + const int bit = 32 - __builtin_clz(reverse); + return bit - 1; +} + +#else + +tlsf_decl int tlsf_ffs(unsigned int word) +{ + return __builtin_ffs(word) - 1; +} + +#endif + +tlsf_decl int tlsf_fls(unsigned int word) +{ + const int bit = word ? 32 - __builtin_clz(word) : 0; + return bit - 1; +} + +#elif defined (_MSC_VER) && (_MSC_VER >= 1400) && (defined (_M_IX86) || defined (_M_X64)) +/* Microsoft Visual C++ support on x86/X64 architectures. */ + +#include + +#pragma intrinsic(_BitScanReverse) +#pragma intrinsic(_BitScanForward) + +tlsf_decl int tlsf_fls(unsigned int word) +{ + unsigned long index; + return _BitScanReverse(&index, word) ? index : -1; +} + +tlsf_decl int tlsf_ffs(unsigned int word) +{ + unsigned long index; + return _BitScanForward(&index, word) ? index : -1; +} + +#elif defined (_MSC_VER) && defined (_M_PPC) +/* Microsoft Visual C++ support on PowerPC architectures. */ + +#include + +tlsf_decl int tlsf_fls(unsigned int word) +{ + const int bit = 32 - _CountLeadingZeros(word); + return bit - 1; +} + +tlsf_decl int tlsf_ffs(unsigned int word) +{ + const unsigned int reverse = word & (~word + 1); + const int bit = 32 - _CountLeadingZeros(reverse); + return bit - 1; +} + +#elif defined (__ARMCC_VERSION) +/* RealView Compilation Tools for ARM */ + +tlsf_decl int tlsf_ffs(unsigned int word) +{ + const unsigned int reverse = word & (~word + 1); + const int bit = 32 - __clz(reverse); + return bit - 1; +} + +tlsf_decl int tlsf_fls(unsigned int word) +{ + const int bit = word ? 32 - __clz(word) : 0; + return bit - 1; +} + +#elif defined (__ghs__) +/* Green Hills support for PowerPC */ + +#include + +tlsf_decl int tlsf_ffs(unsigned int word) +{ + const unsigned int reverse = word & (~word + 1); + const int bit = 32 - __CLZ32(reverse); + return bit - 1; +} + +tlsf_decl int tlsf_fls(unsigned int word) +{ + const int bit = word ? 32 - __CLZ32(word) : 0; + return bit - 1; +} + +#else +/* Fall back to generic implementation. */ + +/* Implement ffs in terms of fls. */ +tlsf_decl int tlsf_ffs(unsigned int word) +{ + const unsigned int reverse = word & (~word + 1); + return TLSF_FLS32(reverse) - 1; +} + +tlsf_decl int tlsf_fls(unsigned int word) +{ + return TLSF_FLS32(word) - 1; +} + +#endif + +/* Possibly 64-bit version of tlsf_fls. */ +#if defined (TLSF_64BIT) +tlsf_decl int tlsf_fls_sizet(size_t size) +{ + int high = (int)(size >> 32); + int bits = 0; + if (high) + { + bits = 32 + tlsf_fls(high); + } + else + { + bits = tlsf_fls((int)size & 0xffffffff); + + } + return bits; +} +#else +#define tlsf_fls_sizet tlsf_fls +#endif + +#undef tlsf_decl + +/* +** Constants. +*/ + +/* Public constants: may be modified. */ +enum tlsf_public +{ + /* log2 of number of linear subdivisions of block sizes. Larger + ** values require more memory in the control structure. Values of + ** 4 or 5 are typical. + */ + SL_INDEX_COUNT_LOG2 = 5, +}; + +/* Private constants: do not modify. */ +enum tlsf_private +{ +#if defined (TLSF_64BIT) + /* All allocation sizes and addresses are aligned to 8 bytes. */ + ALIGN_SIZE_LOG2 = 3, +#else + /* All allocation sizes and addresses are aligned to 4 bytes. */ + ALIGN_SIZE_LOG2 = 2, +#endif + ALIGN_SIZE = (1 << ALIGN_SIZE_LOG2), + + /* + ** We support allocations of sizes up to (1 << FL_INDEX_MAX) bits. + ** However, because we linearly subdivide the second-level lists, and + ** our minimum size granularity is 4 bytes, it doesn't make sense to + ** create first-level lists for sizes smaller than SL_INDEX_COUNT * 4, + ** or (1 << (SL_INDEX_COUNT_LOG2 + 2)) bytes, as there we will be + ** trying to split size ranges into more slots than we have available. + ** Instead, we calculate the minimum threshold size, and place all + ** blocks below that size into the 0th first-level list. + */ + +#if defined (TLSF_MAX_POOL_SIZE) + FL_INDEX_MAX = TLSF_LOG2_CEIL(TLSF_MAX_POOL_SIZE), +#elif defined (TLSF_64BIT) + /* + ** TODO: We can increase this to support larger sizes, at the expense + ** of more overhead in the TLSF structure. + */ + FL_INDEX_MAX = 32, +#else + FL_INDEX_MAX = 30, +#endif + SL_INDEX_COUNT = (1 << SL_INDEX_COUNT_LOG2), + FL_INDEX_SHIFT = (SL_INDEX_COUNT_LOG2 + ALIGN_SIZE_LOG2), + FL_INDEX_COUNT = (FL_INDEX_MAX - FL_INDEX_SHIFT + 1), + + SMALL_BLOCK_SIZE = (1 << FL_INDEX_SHIFT), +}; + +/* +** Cast and min/max macros. +*/ + +#define tlsf_cast(t, exp) ((t) (exp)) +#define tlsf_min(a, b) ((a) < (b) ? (a) : (b)) +#define tlsf_max(a, b) ((a) > (b) ? (a) : (b)) + +/* +** Set assert macro, if it has not been provided by the user. +*/ +#if !defined (tlsf_assert) +#define tlsf_assert assert +#endif + +/* +** Static assertion mechanism. +*/ + +#define _tlsf_glue2(x, y) x ## y +#define _tlsf_glue(x, y) _tlsf_glue2(x, y) +#define tlsf_static_assert(exp) \ + typedef char _tlsf_glue(static_assert, __LINE__) [(exp) ? 1 : -1] + +/* This code has been tested on 32- and 64-bit (LP/LLP) architectures. */ +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); + +/* +** Data structures and associated constants. +*/ + +/* +** Block header structure. +** +** There are several implementation subtleties involved: +** - The prev_phys_block field is only valid if the previous block is free. +** - The prev_phys_block field is actually stored at the end of the +** previous block. It appears at the beginning of this structure only to +** simplify the implementation. +** - The next_free / prev_free fields are only valid if the block is free. +*/ +typedef struct block_header_t +{ + /* Points to the previous physical block. */ + struct block_header_t* prev_phys_block; + + /* The size of this block, excluding the block header. */ + size_t size; + + /* Next and previous free blocks. */ + struct block_header_t* next_free; + struct block_header_t* prev_free; +} block_header_t; + +/* +** Since block sizes are always at least a multiple of 4, the two least +** significant bits of the size field are used to store the block status: +** - bit 0: whether block is busy or free +** - bit 1: whether previous block is busy or free +*/ +static const size_t block_header_free_bit = 1 << 0; +static const size_t block_header_prev_free_bit = 1 << 1; + +/* +** The size of the block header exposed to used blocks is the size field. +** The prev_phys_block field is stored *inside* the previous free block. +*/ +static const size_t block_header_overhead = sizeof(size_t); + +/* User data starts directly after the size field in a used block. */ +static const size_t block_start_offset = + offsetof(block_header_t, size) + sizeof(size_t); + +/* +** A free block must be large enough to store its header minus the size of +** the prev_phys_block field, and no larger than the number of addressable +** bits for FL_INDEX. +*/ +static const size_t block_size_min = + sizeof(block_header_t) - sizeof(block_header_t*); +static const size_t block_size_max = tlsf_cast(size_t, 1) << FL_INDEX_MAX; + + +/* The TLSF control structure. */ +typedef struct control_t +{ + /* Empty lists point at this block to indicate they are free. */ + block_header_t block_null; + + /* Bitmaps for free lists. */ + unsigned int fl_bitmap; + unsigned int sl_bitmap[FL_INDEX_COUNT]; + + /* Head of free lists. */ + block_header_t* blocks[FL_INDEX_COUNT][SL_INDEX_COUNT]; +} control_t; + +/* A type used for casting when doing pointer arithmetic. */ +typedef ptrdiff_t tlsfptr_t; + +/* +** block_header_t member functions. +*/ + +static size_t block_size(const block_header_t* block) +{ + return block->size & ~(block_header_free_bit | block_header_prev_free_bit); +} + +static void block_set_size(block_header_t* block, size_t size) +{ + const size_t oldsize = block->size; + block->size = size | (oldsize & (block_header_free_bit | block_header_prev_free_bit)); +} + +static int block_is_last(const block_header_t* block) +{ + return block_size(block) == 0; +} + +static int block_is_free(const block_header_t* block) +{ + return tlsf_cast(int, block->size & block_header_free_bit); +} + +static void block_set_free(block_header_t* block) +{ + block->size |= block_header_free_bit; +} + +static void block_set_used(block_header_t* block) +{ + block->size &= ~block_header_free_bit; +} + +static int block_is_prev_free(const block_header_t* block) +{ + return tlsf_cast(int, block->size & block_header_prev_free_bit); +} + +static void block_set_prev_free(block_header_t* block) +{ + block->size |= block_header_prev_free_bit; +} + +static void block_set_prev_used(block_header_t* block) +{ + block->size &= ~block_header_prev_free_bit; +} + +static block_header_t* block_from_ptr(const void* ptr) +{ + return tlsf_cast(block_header_t*, + tlsf_cast(unsigned char*, ptr) - block_start_offset); +} + +static void* block_to_ptr(const block_header_t* block) +{ + return tlsf_cast(void*, + tlsf_cast(unsigned char*, block) + block_start_offset); +} + +/* Return location of next block after block of given size. */ +static block_header_t* offset_to_block(const void* ptr, size_t size) +{ + return tlsf_cast(block_header_t*, tlsf_cast(tlsfptr_t, ptr) + size); +} + +/* Return location of previous block. */ +static block_header_t* block_prev(const block_header_t* block) +{ + tlsf_assert(block_is_prev_free(block) && "previous block must be free"); + return block->prev_phys_block; +} + +/* Return location of next existing block. */ +static block_header_t* block_next(const block_header_t* block) +{ + block_header_t* next = offset_to_block(block_to_ptr(block), + block_size(block) - block_header_overhead); + tlsf_assert(!block_is_last(block)); + return next; +} + +/* Link a new block with its physical neighbor, return the neighbor. */ +static block_header_t* block_link_next(block_header_t* block) +{ + block_header_t* next = block_next(block); + next->prev_phys_block = block; + return next; +} + +static void block_mark_as_free(block_header_t* block) +{ + /* Link the block to the next block, first. */ + block_header_t* next = block_link_next(block); + block_set_prev_free(next); + block_set_free(block); +} + +static void block_mark_as_used(block_header_t* block) +{ + block_header_t* next = block_next(block); + block_set_prev_used(next); + block_set_used(block); +} + +static size_t align_up(size_t x, size_t align) +{ + tlsf_assert(0 == (align & (align - 1)) && "must align to a power of two"); + return (x + (align - 1)) & ~(align - 1); +} + +static size_t align_down(size_t x, size_t align) +{ + tlsf_assert(0 == (align & (align - 1)) && "must align to a power of two"); + return x - (x & (align - 1)); +} + +static void* align_ptr(const void* ptr, size_t align) +{ + const tlsfptr_t aligned = + (tlsf_cast(tlsfptr_t, ptr) + (align - 1)) & ~(align - 1); + tlsf_assert(0 == (align & (align - 1)) && "must align to a power of two"); + return tlsf_cast(void*, aligned); +} + +/* +** Adjust an allocation size to be aligned to word size, and no smaller +** than internal minimum. +*/ +static size_t adjust_request_size(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) + { + adjust = tlsf_max(aligned, block_size_min); + } + } + return adjust; +} + +/* +** TLSF utility functions. In most cases, these are direct translations of +** the documentation found in the white paper. +*/ + +static void mapping_insert(size_t size, int* fli, int* sli) +{ + int fl, sl; + if (size < SMALL_BLOCK_SIZE) + { + /* Store small blocks in first list. */ + fl = 0; + sl = tlsf_cast(int, size) / (SMALL_BLOCK_SIZE / SL_INDEX_COUNT); + } + else + { + fl = tlsf_fls_sizet(size); + sl = tlsf_cast(int, size >> (fl - SL_INDEX_COUNT_LOG2)) ^ (1 << SL_INDEX_COUNT_LOG2); + fl -= (FL_INDEX_SHIFT - 1); + } + *fli = fl; + *sli = sl; +} + +/* This version rounds up to the next block size (for allocations) */ +static void mapping_search(size_t size, int* fli, int* sli) +{ + if (size >= SMALL_BLOCK_SIZE) + { + const size_t round = (1 << (tlsf_fls_sizet(size) - SL_INDEX_COUNT_LOG2)) - 1; + size += round; + } + mapping_insert(size, fli, sli); +} + +static block_header_t* search_suitable_block(control_t* control, int* fli, int* sli) +{ + int fl = *fli; + int sl = *sli; + + /* + ** First, search for a block in the list associated with the given + ** fl/sl index. + */ + unsigned int sl_map = control->sl_bitmap[fl] & (~0U << sl); + if (!sl_map) + { + /* No block exists. Search in the next largest first-level list. */ + const unsigned int fl_map = control->fl_bitmap & (~0U << (fl + 1)); + if (!fl_map) + { + /* No free blocks available, memory has been exhausted. */ + return 0; + } + + fl = tlsf_ffs(fl_map); + *fli = fl; + sl_map = control->sl_bitmap[fl]; + } + tlsf_assert(sl_map && "internal error - second level bitmap is null"); + sl = tlsf_ffs(sl_map); + *sli = sl; + + /* Return the first block in the free list. */ + return control->blocks[fl][sl]; +} + +/* Remove a free block from the free list.*/ +static void remove_free_block(control_t* control, block_header_t* block, int fl, int sl) +{ + block_header_t* prev = block->prev_free; + block_header_t* next = block->next_free; + tlsf_assert(prev && "prev_free field can not be null"); + tlsf_assert(next && "next_free field can not be null"); + next->prev_free = prev; + prev->next_free = next; + + /* If this block is the head of the free list, set new head. */ + if (control->blocks[fl][sl] == block) + { + control->blocks[fl][sl] = next; + + /* If the new head is null, clear the bitmap. */ + if (next == &control->block_null) + { + control->sl_bitmap[fl] &= ~(1U << sl); + + /* If the second bitmap is now empty, clear the fl bitmap. */ + if (!control->sl_bitmap[fl]) + { + control->fl_bitmap &= ~(1U << fl); + } + } + } +} + +/* Insert a free block into the free block list. */ +static void insert_free_block(control_t* control, block_header_t* block, int fl, int sl) +{ + block_header_t* current = control->blocks[fl][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; + block->prev_free = &control->block_null; + current->prev_free = block; + + tlsf_assert(block_to_ptr(block) == align_ptr(block_to_ptr(block), ALIGN_SIZE) + && "block not aligned properly"); + /* + ** 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->fl_bitmap |= (1U << fl); + control->sl_bitmap[fl] |= (1U << sl); +} + +/* Remove a given block from the free list. */ +static void block_remove(control_t* control, block_header_t* block) +{ + int fl, sl; + mapping_insert(block_size(block), &fl, &sl); + remove_free_block(control, block, fl, sl); +} + +/* Insert a given block into the free list. */ +static void block_insert(control_t* control, block_header_t* block) +{ + int fl, sl; + mapping_insert(block_size(block), &fl, &sl); + insert_free_block(control, block, fl, sl); +} + +static int block_can_split(block_header_t* block, size_t size) +{ + return block_size(block) >= sizeof(block_header_t) + size; +} + +/* Split a block into two, the second of which is free. */ +static block_header_t* block_split(block_header_t* block, size_t size) +{ + /* Calculate the amount of space left in the remaining block. */ + block_header_t* remaining = + offset_to_block(block_to_ptr(block), size - block_header_overhead); + + const size_t remain_size = block_size(block) - (size + block_header_overhead); + + tlsf_assert(block_to_ptr(remaining) == align_ptr(block_to_ptr(remaining), ALIGN_SIZE) + && "remaining block not aligned properly"); + + tlsf_assert(block_size(block) == remain_size + size + block_header_overhead); + block_set_size(remaining, remain_size); + tlsf_assert(block_size(remaining) >= block_size_min && "block split with invalid size"); + + block_set_size(block, size); + block_mark_as_free(remaining); + + return remaining; +} + +/* Absorb a free block's storage into an adjacent previous free block. */ +static block_header_t* block_absorb(block_header_t* prev, block_header_t* block) +{ + tlsf_assert(!block_is_last(prev) && "previous block can't be last"); + /* Note: Leaves flags untouched. */ + prev->size += block_size(block) + block_header_overhead; + block_link_next(prev); + return prev; +} + +/* Merge a just-freed block with an adjacent previous free block. */ +static block_header_t* block_merge_prev(control_t* control, block_header_t* block) +{ + if (block_is_prev_free(block)) + { + block_header_t* prev = block_prev(block); + tlsf_assert(prev && "prev physical block can't be null"); + tlsf_assert(block_is_free(prev) && "prev block is not free though marked as such"); + block_remove(control, prev); + block = block_absorb(prev, block); + } + + return block; +} + +/* Merge a just-freed block with an adjacent free block. */ +static block_header_t* block_merge_next(control_t* control, block_header_t* block) +{ + block_header_t* next = block_next(block); + tlsf_assert(next && "next physical block can't be null"); + + if (block_is_free(next)) + { + tlsf_assert(!block_is_last(block) && "previous block can't be last"); + block_remove(control, next); + block = block_absorb(block, next); + } + + return block; +} + +/* Trim any trailing block space off the end of a block, return to pool. */ +static void block_trim_free(control_t* control, block_header_t* block, size_t size) +{ + tlsf_assert(block_is_free(block) && "block must be free"); + if (block_can_split(block, size)) + { + block_header_t* remaining_block = block_split(block, size); + block_link_next(block); + block_set_prev_free(remaining_block); + block_insert(control, remaining_block); + } +} + +/* Trim any trailing block space off the end of a used block, return to pool. */ +static void block_trim_used(control_t* control, block_header_t* block, size_t size) +{ + tlsf_assert(!block_is_free(block) && "block must be used"); + if (block_can_split(block, size)) + { + /* If the next block is free, we must coalesce. */ + block_header_t* remaining_block = block_split(block, size); + block_set_prev_used(remaining_block); + + remaining_block = block_merge_next(control, remaining_block); + block_insert(control, remaining_block); + } +} + +static block_header_t* block_trim_free_leading(control_t* control, block_header_t* block, size_t size) +{ + block_header_t* remaining_block = block; + if (block_can_split(block, size)) + { + /* We want the 2nd block. */ + remaining_block = block_split(block, size - block_header_overhead); + block_set_prev_free(remaining_block); + + block_link_next(block); + block_insert(control, block); + } + + return remaining_block; +} + +static block_header_t* block_locate_free(control_t* control, size_t size) +{ + int fl = 0, sl = 0; + block_header_t* block = 0; + + if (size) + { + mapping_search(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) + { + block = search_suitable_block(control, &fl, &sl); + } + } + + if (block) + { + tlsf_assert(block_size(block) >= size); + remove_free_block(control, block, fl, sl); + } + + return block; +} + +static void* block_prepare_used(control_t* control, block_header_t* block, size_t size) +{ + void* p = 0; + if (block) + { + tlsf_assert(size && "size must be non-zero"); + block_trim_free(control, block, size); + block_mark_as_used(block); + p = block_to_ptr(block); + } + return p; +} + +/* Clear structure and point all empty lists at the null block. */ +static void control_construct(control_t* control) +{ + int i, j; + + control->block_null.next_free = &control->block_null; + control->block_null.prev_free = &control->block_null; + + control->fl_bitmap = 0; + for (i = 0; i < FL_INDEX_COUNT; ++i) + { + control->sl_bitmap[i] = 0; + for (j = 0; j < SL_INDEX_COUNT; ++j) + { + control->blocks[i][j] = &control->block_null; + } + } +} + +/* +** Debugging utilities. +*/ + +typedef struct integrity_t +{ + int prev_status; + int status; +} integrity_t; + +#define tlsf_insist(x) { tlsf_assert(x); if (!(x)) { status--; } } + +static void integrity_walker(void* ptr, size_t size, int used, void* user) +{ + block_header_t* block = block_from_ptr(ptr); + integrity_t* integ = tlsf_cast(integrity_t*, user); + const int this_prev_status = block_is_prev_free(block) ? 1 : 0; + const int this_status = block_is_free(block) ? 1 : 0; + const size_t this_block_size = block_size(block); + + int status = 0; + (void)used; + tlsf_insist(integ->prev_status == this_prev_status && "prev status incorrect"); + tlsf_insist(size == this_block_size && "block size incorrect"); + + integ->prev_status = this_status; + integ->status += status; +} + +int tlsf_check(tlsf_t tlsf) +{ + int i, j; + + control_t* control = tlsf_cast(control_t*, tlsf); + int status = 0; + + /* Check that the free lists and bitmaps are accurate. */ + for (i = 0; i < FL_INDEX_COUNT; ++i) + { + for (j = 0; j < SL_INDEX_COUNT; ++j) + { + const int fl_map = control->fl_bitmap & (1U << i); + const int sl_list = control->sl_bitmap[i]; + const int sl_map = sl_list & (1U << j); + const block_header_t* block = control->blocks[i][j]; + + /* Check that first- and second-level lists agree. */ + if (!fl_map) + { + tlsf_insist(!sl_map && "second-level map must be null"); + } + + if (!sl_map) + { + tlsf_insist(block == &control->block_null && "block list must be null"); + continue; + } + + /* Check that there is at least one free block. */ + tlsf_insist(sl_list && "no free blocks in second-level map"); + tlsf_insist(block != &control->block_null && "block should not be null"); + + while (block != &control->block_null) + { + int fli, sli; + tlsf_insist(block_is_free(block) && "block should be free"); + tlsf_insist(!block_is_prev_free(block) && "blocks should have coalesced"); + tlsf_insist(!block_is_free(block_next(block)) && "blocks should have coalesced"); + 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); + tlsf_insist(fli == i && sli == j && "block size indexed in wrong list"); + block = block->next_free; + } + } + } + + return status; +} + +#undef tlsf_insist + +static void default_walker(void* ptr, size_t size, int used, void* user) +{ + (void)user; + printf("\t%p %s size: %x (%p)\n", ptr, used ? "used" : "free", (unsigned int)size, (void*)block_from_ptr(ptr)); +} + +void tlsf_walk_pool(pool_t pool, tlsf_walker walker, void* user) +{ + tlsf_walker pool_walker = walker ? walker : default_walker; + block_header_t* block = + offset_to_block(pool, -(int)block_header_overhead); + + while (block && !block_is_last(block)) + { + pool_walker( + block_to_ptr(block), + block_size(block), + !block_is_free(block), + user); + block = block_next(block); + } +} + +size_t tlsf_block_size(void* ptr) +{ + size_t size = 0; + if (ptr) + { + const block_header_t* block = block_from_ptr(ptr); + size = block_size(block); + } + return size; +} + +int tlsf_check_pool(pool_t pool) +{ + /* Check that the blocks are physically correct. */ + integrity_t integ = { 0, 0 }; + tlsf_walk_pool(pool, integrity_walker, &integ); + + return integ.status; +} + +/* +** 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) +{ + return sizeof(control_t); +} + +size_t tlsf_align_size(void) +{ + return ALIGN_SIZE; +} + +size_t tlsf_block_size_min(void) +{ + return block_size_min; +} + +size_t tlsf_block_size_max(void) +{ + return block_size_max; +} + +/* +** Overhead of the TLSF structures in a given memory block passed to +** tlsf_add_pool, equal to the overhead of a free block and the +** sentinel block. +*/ +size_t tlsf_pool_overhead(void) +{ + return 2 * block_header_overhead; +} + +size_t tlsf_alloc_overhead(void) +{ + return block_header_overhead; +} + +pool_t tlsf_add_pool(tlsf_t tlsf, void* mem, size_t bytes) +{ + block_header_t* block; + block_header_t* next; + + const size_t pool_overhead = tlsf_pool_overhead(); + const size_t pool_bytes = align_down(bytes - pool_overhead, ALIGN_SIZE); + + if (((ptrdiff_t)mem % ALIGN_SIZE) != 0) + { + printf("tlsf_add_pool: Memory must be aligned by %u bytes.\n", + (unsigned int)ALIGN_SIZE); + return 0; + } + + if (pool_bytes < block_size_min || pool_bytes > block_size_max) + { +#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)); +#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)); +#endif + return 0; + } + + /* + ** Create the main free block. Offset the start of the block slightly + ** so that the prev_phys_block field falls outside of the pool - + ** it will never be used. + */ + block = offset_to_block(mem, -(tlsfptr_t)block_header_overhead); + block_set_size(block, pool_bytes); + block_set_free(block); + block_set_prev_used(block); + block_insert(tlsf_cast(control_t*, tlsf), block); + + /* Split the block to create a zero-size sentinel block. */ + next = block_link_next(block); + block_set_size(next, 0); + block_set_used(next); + block_set_prev_free(next); + + return mem; +} + +void tlsf_remove_pool(tlsf_t tlsf, pool_t pool) +{ + control_t* control = tlsf_cast(control_t*, tlsf); + block_header_t* block = offset_to_block(pool, -(int)block_header_overhead); + + int fl = 0, sl = 0; + + tlsf_assert(block_is_free(block) && "block should be free"); + 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); + remove_free_block(control, block, fl, sl); +} + +/* +** TLSF main interface. +*/ + +#if _DEBUG +int test_ffs_fls() +{ + /* Verify ffs/fls work properly. */ + int rv = 0; + rv += (tlsf_ffs(0) == -1) ? 0 : 0x1; + rv += (tlsf_fls(0) == -1) ? 0 : 0x2; + rv += (tlsf_ffs(1) == 0) ? 0 : 0x4; + rv += (tlsf_fls(1) == 0) ? 0 : 0x8; + rv += (tlsf_ffs(0x80000000) == 31) ? 0 : 0x10; + rv += (tlsf_ffs(0x80008000) == 15) ? 0 : 0x20; + rv += (tlsf_fls(0x80000008) == 31) ? 0 : 0x40; + rv += (tlsf_fls(0x7FFFFFFF) == 30) ? 0 : 0x80; + +#if defined (TLSF_64BIT) + rv += (tlsf_fls_sizet(0x80000000) == 31) ? 0 : 0x100; + rv += (tlsf_fls_sizet(0x100000000) == 32) ? 0 : 0x200; + rv += (tlsf_fls_sizet(0xffffffffffffffff) == 63) ? 0 : 0x400; +#endif + + if (rv) + { + printf("test_ffs_fls: %x ffs/fls tests failed.\n", rv); + } + return rv; +} +#endif + +tlsf_t tlsf_create(void* mem) +{ +#if _DEBUG + if (test_ffs_fls()) + { + return 0; + } +#endif + + if (((tlsfptr_t)mem % ALIGN_SIZE) != 0) + { + printf("tlsf_create: Memory must be aligned to %u bytes.\n", + (unsigned int)ALIGN_SIZE); + return 0; + } + + control_construct(tlsf_cast(control_t*, mem)); + + return tlsf_cast(tlsf_t, mem); +} + +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()); + return tlsf; +} + +void tlsf_destroy(tlsf_t tlsf) +{ + /* Nothing to do. */ + (void)tlsf; +} + +pool_t tlsf_get_pool(tlsf_t tlsf) +{ + return tlsf_cast(pool_t, (char*)tlsf + tlsf_size()); +} + +void* tlsf_malloc(tlsf_t tlsf, size_t size) +{ + control_t* control = tlsf_cast(control_t*, tlsf); + const size_t adjust = adjust_request_size(size, ALIGN_SIZE); + block_header_t* block = block_locate_free(control, adjust); + return block_prepare_used(control, block, adjust); +} + +void* tlsf_memalign(tlsf_t tlsf, size_t align, size_t size) +{ + control_t* control = tlsf_cast(control_t*, tlsf); + const size_t adjust = adjust_request_size(size, ALIGN_SIZE); + + /* + ** We must allocate an additional minimum block size bytes so that if + ** our free block will leave an alignment gap which is smaller, we can + ** trim a leading free block and release it back to the pool. We must + ** do this because the previous physical block is in use, therefore + ** the prev_phys_block field is not valid, and we can't simply adjust + ** the size of that block. + */ + const size_t gap_minimum = sizeof(block_header_t); + const size_t size_with_gap = adjust_request_size(adjust + align + gap_minimum, align); + + /* + ** If alignment is less than or equals base alignment, we're done. + ** If we requested 0 bytes, return null, as tlsf_malloc(0) does. + */ + const size_t aligned_size = (adjust && align > ALIGN_SIZE) ? size_with_gap : adjust; + + block_header_t* block = block_locate_free(control, aligned_size); + + /* This can't be a static assert. */ + tlsf_assert(sizeof(block_header_t) == block_size_min + block_header_overhead); + + if (block) + { + void* ptr = block_to_ptr(block); + void* aligned = align_ptr(ptr, align); + size_t gap = tlsf_cast(size_t, + tlsf_cast(tlsfptr_t, aligned) - tlsf_cast(tlsfptr_t, ptr)); + + /* If gap size is too small, offset to next aligned boundary. */ + if (gap && gap < gap_minimum) + { + const size_t gap_remain = gap_minimum - gap; + const size_t offset = tlsf_max(gap_remain, align); + const void* next_aligned = tlsf_cast(void*, + tlsf_cast(tlsfptr_t, aligned) + offset); + + aligned = align_ptr(next_aligned, align); + gap = tlsf_cast(size_t, + tlsf_cast(tlsfptr_t, aligned) - tlsf_cast(tlsfptr_t, ptr)); + } + + if (gap) + { + tlsf_assert(gap >= gap_minimum && "gap size too small"); + block = block_trim_free_leading(control, block, gap); + } + } + + return block_prepare_used(control, block, adjust); +} + +void tlsf_free(tlsf_t tlsf, void* ptr) +{ + /* Don't attempt to free a NULL pointer. */ + if (ptr) + { + control_t* control = tlsf_cast(control_t*, tlsf); + block_header_t* block = block_from_ptr(ptr); + tlsf_assert(!block_is_free(block) && "block already marked as free"); + block_mark_as_free(block); + block = block_merge_prev(control, block); + block = block_merge_next(control, block); + block_insert(control, block); + } +} + +/* +** The TLSF block information provides us with enough information to +** provide a reasonably intelligent implementation of realloc, growing or +** shrinking the currently allocated block as required. +** +** This routine handles the somewhat esoteric edge cases of realloc: +** - a non-zero size with a null pointer will behave like malloc +** - a zero size with a non-null pointer will behave like free +** - a request that cannot be satisfied will leave the original buffer +** untouched +** - an extended buffer size will leave the newly-allocated area with +** contents undefined +*/ +void* tlsf_realloc(tlsf_t tlsf, void* ptr, size_t size) +{ + control_t* control = tlsf_cast(control_t*, tlsf); + void* p = 0; + + /* Zero-size requests are treated as free. */ + if (ptr && size == 0) + { + tlsf_free(tlsf, ptr); + } + /* Requests with NULL pointers are treated as malloc. */ + else if (!ptr) + { + p = tlsf_malloc(tlsf, size); + } + else + { + block_header_t* block = block_from_ptr(ptr); + block_header_t* next = block_next(block); + + 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); + + tlsf_assert(!block_is_free(block) && "block already marked as free"); + + /* + ** If the next block is used, or when combined with the current + ** block, does not offer enough space, we must reallocate and copy. + */ + if (adjust > cursize && (!block_is_free(next) || adjust > combined)) + { + p = tlsf_malloc(tlsf, size); + if (p) + { + const size_t minsize = tlsf_min(cursize, size); + memcpy(p, ptr, minsize); + tlsf_free(tlsf, ptr); + } + } + else + { + /* Do we need to expand to the next block? */ + if (adjust > cursize) + { + block_merge_next(control, block); + block_mark_as_used(block); + } + + /* Trim the resulting block and return the original pointer. */ + block_trim_used(control, block, adjust); + p = ptr; + } + } + + return p; +} + +#endif /* LV_MEM_CUSTOM == 0 */ diff --git a/src/lv_misc/lv_tlsf.h b/src/lv_misc/lv_tlsf.h new file mode 100644 index 000000000..1f5da988c --- /dev/null +++ b/src/lv_misc/lv_tlsf.h @@ -0,0 +1,95 @@ +#include "../lv_conf_internal.h" +#if LV_MEM_CUSTOM == 0 + +#ifndef INCLUDED_tlsf +#define INCLUDED_tlsf + +/* +** Two Level Segregated Fit memory allocator, version 3.1. +** Written by Matthew Conte +** http://tlsf.baisoku.org +** +** Based on the original documentation by Miguel Masmano: +** http://www.gii.upv.es/tlsf/main/docs +** +** This implementation was written to the specification +** of the document, therefore no GPL restrictions apply. +** +** Copyright (c) 2006-2016, Matthew Conte +** All rights reserved. +** +** Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in the +** documentation and/or other materials provided with the distribution. +** * Neither the name of the copyright holder nor the +** names of its contributors may be used to endorse or promote products +** derived from this software without specific prior written permission. +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +** DISCLAIMED. IN NO EVENT SHALL MATTHEW CONTE BE LIABLE FOR ANY +** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + +#include + +#if defined(__cplusplus) +extern "C" { +#endif + +/* tlsf_t: a TLSF structure. Can contain 1 to N pools. */ +/* pool_t: a block of memory that TLSF can manage. */ +typedef void* tlsf_t; +typedef void* pool_t; + +/* Create/destroy a memory pool. */ +tlsf_t tlsf_create(void* mem); +tlsf_t tlsf_create_with_pool(void* mem, size_t bytes); +void tlsf_destroy(tlsf_t tlsf); +pool_t tlsf_get_pool(tlsf_t tlsf); + +/* Add/remove memory pools. */ +pool_t tlsf_add_pool(tlsf_t tlsf, void* mem, size_t bytes); +void tlsf_remove_pool(tlsf_t tlsf, pool_t pool); + +/* malloc/memalign/realloc/free replacements. */ +void* tlsf_malloc(tlsf_t tlsf, size_t bytes); +void* tlsf_memalign(tlsf_t tlsf, size_t align, size_t bytes); +void* tlsf_realloc(tlsf_t tlsf, void* ptr, size_t size); +void tlsf_free(tlsf_t tlsf, void* ptr); + +/* Returns internal block size, not original request size */ +size_t tlsf_block_size(void* ptr); + +/* Overheads/limits of internal structures. */ +size_t tlsf_size(void); +size_t tlsf_align_size(void); +size_t tlsf_block_size_min(void); +size_t tlsf_block_size_max(void); +size_t tlsf_pool_overhead(void); +size_t tlsf_alloc_overhead(void); + +/* Debugging. */ +typedef void (*tlsf_walker)(void* ptr, size_t size, int used, void* user); +void tlsf_walk_pool(pool_t pool, tlsf_walker walker, void* user); +/* Returns nonzero if any internal consistency check fails. */ +int tlsf_check(tlsf_t tlsf); +int tlsf_check_pool(pool_t pool); + +#if defined(__cplusplus) +}; +#endif + +#endif + +#endif /* LV_MEM_CUSTOM == 0 */ diff --git a/tests/lv_test_core/lv_test_style.c b/tests/lv_test_core/lv_test_style.c index 1a9109a45..ed220b02c 100644 --- a/tests/lv_test_core/lv_test_style.c +++ b/tests/lv_test_core/lv_test_style.c @@ -454,7 +454,6 @@ typedef int _keep_pedantic_happy; // } // // lv_test_assert_int_eq(LV_RES_OK, lv_mem_test(), "Memory integrity check"); -// lv_mem_defrag(); // lv_mem_monitor(&mon_end); // lv_test_assert_int_lt(sizeof(void*) * 8, mon_start.free_size - mon_end.free_size, "Style memory leak"); // @@ -478,7 +477,6 @@ typedef int _keep_pedantic_happy; // // _lv_style_list_reset(&style_list); // lv_test_assert_int_eq(LV_RES_OK, lv_mem_test(), "Memory integrity check"); -// lv_mem_defrag(); // lv_mem_monitor(&mon_end); // lv_test_assert_int_lt(sizeof(void*) * 8, mon_start.free_size - mon_end.free_size, "Style memory leak"); // @@ -505,7 +503,6 @@ typedef int _keep_pedantic_happy; // } // // lv_test_assert_int_eq(LV_RES_OK, lv_mem_test(), "Memory integrity check"); -// lv_mem_defrag(); // lv_mem_monitor(&mon_end); // lv_test_assert_int_lt(sizeof(void*) * 8, mon_start.free_size - mon_end.free_size, "Style memory leak"); // @@ -536,7 +533,6 @@ typedef int _keep_pedantic_happy; // } // // lv_test_assert_int_eq(LV_RES_OK, lv_mem_test(), "Memory integrity check"); -// lv_mem_defrag(); // lv_mem_monitor(&mon_end); // lv_test_assert_int_lt(sizeof(void*) * 8, mon_start.free_size - mon_end.free_size, "Style memory leak"); // @@ -616,7 +612,6 @@ typedef int _keep_pedantic_happy; // lv_style_reset(&style3); // // lv_test_assert_int_eq(LV_RES_OK, lv_mem_test(), "Memory integrity check"); -// lv_mem_defrag(); // lv_mem_monitor(&mon_end); // lv_test_assert_int_lt(sizeof(void*) * 8, mon_start.free_size - mon_end.free_size, "Style memory leak"); //}