memoryAllocator.h

#ifndef _MEMORY_ALLOCATOR_H_
#define _MEMORY_ALLOCATOR_H_
 
#include <stdint.h>
#include <predef.h>
 
/* C Standard Library */
#include <ctype.h>
#include <malloc.h>
#include <stdio.h>
 
/* Portability & uCos Definitions */
#include <basictypes.h>
#include <nbrtos.h>
#include <nbrtoscpu.h>
 
/* NB Runtime Libraries */
#include <constants.h>
 
#ifdef __cplusplus
class MemoryAllocator
{
   public:
    virtual void *allocate(size_t size) = 0;
    virtual void deallocate(void *ptr) = 0;
    virtual void *reallocate(void *ptr, size_t size) = 0;
    virtual ~MemoryAllocator() {}
};
 
class BlockMemoryAllocator : public MemoryAllocator
{
   public:
    BlockMemoryAllocator(void *pMemory, size_t memorySize, size_t blockSize);
    ~BlockMemoryAllocator() override;
    void *allocate(size_t size) override;
    void deallocate(void *ptr) override;
    void *reallocate(void *ptr, size_t size) override;
 
    void printStats() const;
   private:
    struct Block
    {
        Block *prev;
        Block *next;
        bool free;
    };
    void *_pMemory;
    size_t _memorySize;
    OS_CRIT m_critSec;
    Block *_pBlockList;
    size_t _blockSizeMultiplier;   // All blocks are a multiple of this size
 
    const size_t largestSizeToAllocate = 10560;
 
    // Profiling data
    size_t _numAllocations;
    size_t _numDeallocations;
    size_t _numOOMAllocations;
    size_t _numTooLargeAllocations;
    size_t _allocatedMemory;
 
    size_t getBlockSize(Block *pBlock) const;
    size_t getAlignedBlockSize(size_t size) const;
    Block *getBlockFromPointer(void *pBlock) const;
    void splitBlock(Block *pBlock, size_t size);
    void coalesceBlocks(Block *pBlock);
 
};
 
#define CREATE_MEMORY_ALLOCATOR_SRAM(name, memorySize)                      \
    alignas(4) static uint8_t memoryBuffer##name[memorySize] FAST_USER_VAR; \
    BlockMemoryAllocator name(memoryBuffer##name, memorySize, 32)
 
#define CREATE_MEMORY_ALLOCATOR_TCM(name, memorySize)                      \
    alignas(4) static uint8_t memoryBuffer##name[memorySize] FAST_SYS_VAR; \
    BlockMemoryAllocator name(memoryBuffer##name, memorySize, 32)
 
#define CREATE_MEMORY_ALLOCATOR_SDRAM(name, memorySize)       \
    alignas(4) static uint8_t memoryBuffer##name[memorySize]; \
    BlockMemoryAllocator name(memoryBuffer##name, memorySize, 32)
 
/* Buffer-only macros: declare the buffer without a BlockMemoryAllocator object.
 * Used by NBMalloc.cpp for lazy allocator instantiation (allows --gc-sections
 * to strip the buffer when TLS is not used by the application). */
#define CREATE_MEMORY_BUFFER_SRAM(name, memorySize) \
    alignas(4) static uint8_t name[memorySize] FAST_USER_VAR
 
#define CREATE_MEMORY_BUFFER_TCM(name, memorySize) \
    alignas(4) static uint8_t name[memorySize] FAST_SYS_VAR
 
#define CREATE_MEMORY_BUFFER_SDRAM(name, memorySize) \
    alignas(4) static uint8_t name[memorySize]
 
#endif
#endif   // _MEMORY_ALLOCATOR_H_