vsf_heap.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_HEAP_H__
#define __VSF_HEAP_H__
 
/*============================ INCLUDES ======================================*/
 
#include "service/vsf_service_cfg.h"
#if VSF_USE_HEAP == ENABLED
 
#include "hal/arch/vsf_arch.h"
#include "utilities/vsf_utilities.h"
 
#if VSF_HEAP_CFG_TRACE == ENABLED
#   include "service/trace/vsf_trace.h"
#endif
 
#if     defined(__VSF_HEAP_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#   undef __VSF_HEAP_CLASS_IMPLEMENT
#elif   defined(__VSF_HEAP_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#   undef __VSF_HEAP_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#ifndef VSF_HEAP_CFG_TRACE_LEAKAGE
#   define VSF_HEAP_CFG_TRACE_LEAKAGE       DISABLED
#endif
 
#if VSF_ARCH_PROVIDE_HEAP == ENABLED
#   ifndef VSF_USE_ARCH_HEAP
#       define VSF_USE_ARCH_HEAP            ENABLED
#   endif
#else
#   if VSF_USE_ARCH_HEAP == ENABLED
#       warning VSF_USE_ARCH_HEAP is enabled, but arch does not provide heap
#       undef VSF_USE_ARCH_HEAP
#   endif
#   define VSF_USE_ARCH_HEAP                DISABLED
#endif
 
#if !defined(VSF_HEAP_SIZE) && VSF_USE_ARCH_HEAP != ENABLED && !defined(__VSF_APPLET__)
#   warning VSF_HEAP_SIZE is not defined, use 128K as default
#   define VSF_HEAP_SIZE                    (128 * 1024)
#endif
 
#ifndef VSF_HEAP_ALIGN
#   define VSF_HEAP_ALIGN                   (2 * sizeof(uintalu_t))
#endif
 
#if VSF_HEAP_CFG_TRACE == ENABLED
#   define vsf_heap_malloc_aligned(__size, __alignment)                         \
    ({                                                                          \
        void * ptr = vsf_heap_malloc_aligned_imp(__size, __alignment);          \
        vsf_trace_debug("%s: malloc_align 0x%p %d" VSF_TRACE_CFG_LINEEND, __FUNCTION__, ptr, __size);\
        ptr;                                                                    \
    })
#   define vsf_heap_malloc(__size)                                              \
    ({                                                                          \
        void * ptr = vsf_heap_malloc_imp(__size);                               \
        vsf_trace_debug("%s: malloc 0x%p %d" VSF_TRACE_CFG_LINEEND, __FUNCTION__, ptr, __size);\
        ptr;                                                                    \
    })
#   define vsf_heap_realloc_aligned(__buffer, __size, __alignment)              \
    ({                                                                          \
        void * ptr = vsf_heap_realloc_aligned_imp(__buffer, __size, __alignment);\
        vsf_trace_debug("%s: realloc_align 0x%p --> 0x%p %d" VSF_TRACE_CFG_LINEEND, __FUNCTION__, __buffer, ptr, __size);\
        ptr;                                                                    \
    })
#   define vsf_heap_realloc(__buffer, __size)                                   \
    ({                                                                          \
        void * ptr = vsf_heap_realloc_imp(__buffer, __size);                    \
        vsf_trace_debug("%s: realloc 0x%p --> 0x%p %d" VSF_TRACE_CFG_LINEEND, __FUNCTION__, __buffer, ptr, __size);\
        ptr;                                                                    \
    })
#   define vsf_heap_free(__ptr)                                                 \
    ({                                                                          \
        vsf_trace_debug("%s: free 0x%p" VSF_TRACE_CFG_LINEEND, __FUNCTION__, (__ptr));\
        vsf_heap_free_imp(__ptr);                                               \
    })
#else
#   define vsf_heap_malloc_aligned          vsf_heap_malloc_aligned_imp
#   define vsf_heap_malloc                  vsf_heap_malloc_imp
#   define vsf_heap_realloc_aligned         vsf_heap_realloc_aligned_imp
#   define vsf_heap_realloc                 vsf_heap_realloc_imp
#   define vsf_heap_free                    vsf_heap_free_imp
#endif
 
#ifndef VSF_HEAP_CFG_STATISTICS
#   define VSF_HEAP_CFG_STATISTICS          ENABLED
#endif
 
/*============================ TYPES =========================================*/
 
#if VSF_HEAP_CFG_STATISTICS == ENABLED
typedef struct vsf_heap_statistics_t {
    uint32_t all_size;
    uint32_t used_size;
    // Historical peak of used_size since heap init. Lets callers derive
    // the minimum-ever free size as (all_size - max_used_size), which is
    // useful for low-water / worst-case headroom diagnostics.
    uint32_t max_used_size;
    // Size (in bytes, MCB header included) of the largest contiguous
    // free block at the moment of the statistics call. Computed lazily
    // by scanning the freelist -- intended for diagnostic paths only,
    // e.g. fragmentation reporting or pre-allocation feasibility checks.
    uint32_t largest_free_block;
} vsf_heap_statistics_t;
#endif
 
vsf_class(vsf_heap_t) {
    protected_member(
        // get_freelist MUST not return NULL
        vsf_dlist_t * (*get_freelist)(vsf_heap_t *heap, uint_fast32_t size, bool is_alloc);
 
        vsf_dlist_t *freelist;
        uint8_t freelist_num;
    )
#if VSF_HEAP_CFG_STATISTICS == ENABLED
    private_member(
        vsf_heap_statistics_t statistics;
    )
#endif
#if VSF_HEAP_CFG_TRACE_LEAKAGE == ENABLED
    private_member(
        bool locked;
        uint32_t idx;
        uint32_t locked_idx;
        vsf_dlist_t freed_list;
    )
#endif
};
 
declare_interface(i_heap_t)
 
 
def_interface(i_heap_t)
#if VSF_USE_ARCH_HEAP != ENABLED
    void (*Init)            (void);
    void (*AddBuffer)       (uint8_t *buffer, uint_fast32_t size);
    void (*AddMemory)       (vsf_mem_t mem);
#endif
    void *(*MallocAligned)  (uint_fast32_t size, uint_fast32_t alignment);
    void *(*Malloc)         (uint_fast32_t size);
    void *(*ReallocAligned) (void *buffer, uint_fast32_t size, uint_fast32_t alignment);
    void *(*Realloc)        (void *buffer, uint_fast32_t size);
    void (*Free)            (void *buffer);
#if     (VSF_HEAP_CFG_STATISTICS == ENABLED)                                    \
    &&  (   (VSF_USE_ARCH_HEAP != ENABLED)                                      \
        ||  (VSF_ARCH_HEAP_HAS_STATISTICS == ENABLED))
    void (*Statistics)      (vsf_heap_statistics_t *statistics);
#endif
end_def_interface(i_heap_t)
 
/*============================ GLOBAL VARIABLES ==============================*/
 
extern const i_heap_t VSF_HEAP;
 
/*============================ PROTOTYPES ====================================*/
 
// heap class
extern void __vsf_heap_init(vsf_heap_t *heap);
extern void __vsf_heap_add_buffer(vsf_heap_t *heap, uint8_t *buffer, uint_fast32_t size);
extern void * __vsf_heap_malloc_aligned(vsf_heap_t *heap, uint_fast32_t size, uint_fast32_t alignment);
extern void * __vsf_heap_realloc_aligned(vsf_heap_t *heap, void *buffer, uint_fast32_t size, uint_fast32_t alignment);
extern void __vsf_heap_free(vsf_heap_t *heap, void *buffer);
extern bool __vsf_heap_is_free(vsf_heap_t *heap, void *buffer);
extern uint_fast32_t __vsf_heap_size(vsf_heap_t *heap, void *buffer);
#if VSF_HEAP_CFG_STATISTICS == ENABLED
extern void __vsf_heap_statistics(vsf_heap_t *heap, vsf_heap_statistics_t *statistics);
#endif
#if VSF_HEAP_CFG_TRACE_LEAKAGE == ENABLED
// if lock, heap will be locked(no previous allocated memory will be freed, and free operation will be saved in mcb)
// if non-lock, heap will be unlocked, and memory allocated when heap locked will be traced
extern void __vsf_heap_dump(vsf_heap_t *heap, bool lock);
#endif
 
#if VSF_USE_ARCH_HEAP != ENABLED
// default heap
extern void vsf_heap_init(void);
extern void vsf_heap_add_buffer(uint8_t *buffer, uint_fast32_t size);
extern void vsf_heap_add_memory(vsf_mem_t mem);
#endif
#if     (VSF_HEAP_CFG_STATISTICS == ENABLED)                                    \
    &&  (   (VSF_USE_ARCH_HEAP != ENABLED)                                      \
        ||  (VSF_ARCH_HEAP_HAS_STATISTICS == ENABLED))
extern void vsf_heap_statistics(vsf_heap_statistics_t *statistics);
#endif
extern uint_fast32_t vsf_heap_size(uint8_t *buffer);
extern void * vsf_heap_malloc_aligned_imp(uint_fast32_t size, uint_fast32_t alignment);
extern void * vsf_heap_malloc_imp(uint_fast32_t size);
extern void * vsf_heap_realloc_aligned_imp(void *buffer, uint_fast32_t size, uint_fast32_t alignment);
extern void * vsf_heap_realloc_imp(void *buffer, uint_fast32_t size);
extern void vsf_heap_free_imp(void *buffer);
extern bool vsf_heap_is_free(void *buffer);
 
extern void * vsf_heap_calloc(uint_fast32_t n, uint_fast32_t size);
extern char * vsf_heap_strdup(const char *str);
 
#if VSF_HEAP_CFG_TRACE_LEAKAGE == ENABLED
// if lock, heap will be locked(no previous allocated memory will be freed, and free operation will be saved in mcb)
// if non-lock, heap will be unlocked, and memory allocated when heap locked will be traced
extern void vsf_heap_dump(bool lock);
#endif
 
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif